Agency Candidate Notifications

Create candidate notification for the given context type

post/agency/{agency_id}/candidate/{candidate_id}/notifications

Request

  • Base URL
    http://localhost:3010/v1
  • URL
    http://localhost:3010/v1/agency/{agency_id}/candidate/{candidate_id}/notifications
  • Auth
    HTTP basic and HTTP basic and HTTP basic

Headers

Authorizationstring string required

OAuth Bearer token

Contextstring string required

The executing context

Accept'application/json' required

Advertises which content types the client understands

X-Accept-Timezonestring

The timezone the content will be displayed in

Request body

typestring required
dataobject required

Response

The candidate notification resource response

_idstring required
updated_atstring date-time required
created_atstring date-time required
__vinteger required
status'new' | 'opt_out' | 'not_configured' | 'processing' | 'completed' | 'dispatched' required
context_type'agency' | 'agency-group' required
context_type_idstring required
candidate_idstring required
notification_typestring required
versioninteger required
meta_dataobject

Changes

No recorded changes to this operation across all 3 revisions of this API.