HiringCenter Pro
HiringCenter Pro API

Messages

Endpoint:https://api.hiringcenterpro.com/v2

Operations for SMS/text messages.


Send Message

POST
https://api.hiringcenterpro.com/v2
/messages

Sends or logs an SMS/Text message in an existing conversation

Send MessageHeaders

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

Send Message Request Body

  • accountIdstring · required
  • conversationIdstring · required
  • userIdstring
  • bodystring
  • mediaUrlstring · uri
  • sendboolean
    Default: true
  • inboundboolean
    Default: false
  • scheduledboolean
    Default: false
  • scheduledAtinteger · int64

Send Message Responses

OK

  • successboolean
  • messageIdstring
  • conversationIdstring
  • twilioResponseobject | null

Reschedule Message

POST
https://api.hiringcenterpro.com/v2
/messages/reschedule

Reschedule MessageHeaders

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

Reschedule Message Request Body

  • accountIdstring · required
  • conversationIdstring · required
  • messageIdstring · required
  • userIdstring · required
  • scheduledAtinteger · int64 · required

Reschedule Message Responses

OK

No data returned

Delete Scheduled Message

DELETE
https://api.hiringcenterpro.com/v2
/messages/scheduled/{messageId}

Delete Scheduled Messagepath Parameters

  • messageIdstring · required

Delete Scheduled MessageHeaders

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

Delete Scheduled Message Request Body

  • accountIdstring · required
  • conversationIdstring · required
  • userIdstring · required
  • scheduledMessageIdstring

Delete Scheduled Message Responses

OK

No data returned

Suggest Message

POST
https://api.hiringcenterpro.com/v2
/messages/suggest

Suggest MessageHeaders

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

Suggest Message Request Body

  • accountIdstring · required
  • conversationIdstring · required
  • prospectIdstring · required

Suggest Message Responses

OK

  • successboolean
  • suggestedMessagestring
  • conversationIdstring
  • prospectIdstring