Send an invitation

post

https://screen.coderpad.io/assessment/api/v1.1/campaigns/{campaign_id}/actions/send

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

campaign_id

int32

required

id of test campaign used for the test session

Body Params

candidate parameters for which the test is sent

candidate_email

string

email of the candidate, if not provided nothing will be sent to the candidate

candidate_name

string

name of the candidate

recruiter_email

string

email of the recruiter who will receive the test result

tags

string

tags for this test separated by comma

send_invitation_email

boolean

whether send an invitation email to the candidate or not, must not be true if 'candidate_email' is null. 'send_invitation_email' is true by default when 'candidate_email' is provided and false otherwise

send_notification_email_on_bounce

boolean

Defaults to false

whether to send an email to the recruiter when the candidate's invitation bounces (for example, when the candidate's email is rejected by the server) or not

allow_duplicate_invitations

boolean

Defaults to true

Responses

200successful operation

400bad request