Skip to main content
POST
Send a new message to an applicant

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Headers

Idempotency-Key
string

Client-chosen key; replaying the same key + body returns the original response, a different body returns 409.

Body

application/json
applicantId
string
required

Applicant user ID returned by the applicant-list endpoints.

Required string length: 1 - 160
jobId
string
required

Job the creator applied to.

Required string length: 1 - 160
message
string
required

Exact message text to send.

Required string length: 1 - 10000

Send the SideShift job widget before the text message.

Optional approved http(s) interview or calendar URL.

Maximum string length: 2048

Response

The applicant message flow completed.

data
object
required