API Reference

Send WhatsApp screening invitation notifications

post
https://api-screening.digai.ai/api/v1/public/notification/invitation/screening/request

This endpoint allows an authenticated business user to send invitation notifications via WhatsApp for a list of candidates to participate in a screening.

Example Request:
POST /api/v1/public/notification/invitation/screening/request

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Payload containing the screening ID and list of contacts to notify

string
required

The ID of the screening to notify

contacts
array of strings
required

The list of contacts to notify.

contacts*
Responses

400

Bad Request: Invalid or missing parameters.

401

Unauthorized: The token is invalid or expired.

403

Forbidden: The user does not have permission to perform this operation.

404

Not Found: The specified screening does not exist.

429

Too Many Requests: Rate limit exceeded.

Updated 12 months ago

Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago