post

https://partners.apploi.com/applicants/{applicant_id}/message

Creates a new message for a specific application. Messages can be sent to the candidate (outbound) or recorded as responses from the candidate (inbound). Supports both text (SMS) and email message types.

Message Direction:

'to_candidate': Outbound messages sent to the candidate (e.g., from AI system)
'from_candidate': Inbound messages/responses from the candidate

Message Delivery Control:

is_sent_by_vendor: default true if not sent in payload
is_sent_by_vendor=true: Vendor handles message delivery
is_sent_by_vendor=false: Apploi sends the message via SMS/Email infrastructure

Email Requirements: When message_type is 'email', the 'subject' field is required.

Authentication: Requires valid x-api-key header.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicant_id

string

required

The application form ID corresponding to a job application in the Apploi platform. The application form ID is a unique identifier for the job application in the Apploi platform. The application form ID can be found in the 'id' field of the each of the items in the response body of a call to the /applicants endpoint in the Apploi Partner API.

Examples: 265733753, 265733754, etc.

Body Params

Pass in a JSON body with message details. All fields are required except 'subject' when message_type is 'text'.

Required Fields:

external_id: Vendor-specific message identifier
message_type: 'text' or 'email'
message_body: Message content
status: Message status (e.g., 'SENT', 'DELIVERED')
vendor_name: Vendor/service name (e.g., 'abc')
message_direction: 'to_candidate' or 'from_candidate'

Optional Fields:

subject: Required when message_type is 'email'
is_sent_by_vendor: Boolean flag (true = vendor sends, false = Apploi sends) default value is true if not passed in payload

Example - Text Message to Candidate (Vendor Sends):

{
  "external_id": "uuid-123-456",
  "message_type": "text",
  "message_body": "Thank you for applying! We'd like to schedule an interview.",
  "status": "SENT",
  "vendor_name": "abc",
  "message_direction": "to_candidate",
  "is_sent_by_vendor": true
}

Example - Email to Candidate (Apploi Sends):

{
  "external_id": "email-456-789",
  "message_type": "email",
  "message_body": "We are excited to move forward with your application...",
  "subject": "Interview Invitation",
  "status": "SENT",
  "vendor_name": "abc",
  "message_direction": "to_candidate",
  "is_sent_by_vendor": false
}

Example - Response from Candidate (No Optional Fields):

{
  "external_id": "response-789-012",
  "message_type": "text",
  "message_body": "I am available for an interview next week.",
  "status": "DELIVERED",
  "vendor_name": "abc",
  "message_direction": "from_candidate"
}

external_id

string

required

length ≥ 1

External identifier for the message from the vendor system.

is_sent_by_vendor

boolean

[if not sent in payload default: true] Controls message delivery. Set to true if vendor handles SMS/email delivery. Set to false if Apploi should send the message via its infrastructure.

message_body

string

required

length ≥ 1

The content/body of the message to be sent to or from the candidate.

message_direction

string

enum

required

Direction of the message flow. Use 'to_candidate' for messages sent to the candidate (outbound), 'from_candidate' for candidate responses (inbound).

Allowed:

message_type

string

enum

required

Type of message being sent. Must be 'text' for SMS or 'email' for email messages.

Allowed:

status

string

required

length ≥ 1

Current status of the message in the vendor system (e.g., SENT, DELIVERED, FAILED).

subject

string

Email subject line. Required when message_type is 'email', optional for text messages.

vendor_name

string

required

length ≥ 1

Name of the vendor/service sending the message.

Headers

X-Api-Key

string

required

Authorization

string

Responses

400

400 response

403

403 response

404

404 response

405

405 response

200200 response

500500 response