HiringCenter Pro
HiringCenter Pro API

Conversations

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

Operations for conversations and participants.

Get Conversations

GET
https://api.hiringcenterpro.com/v2
/conversations

Get Conversations › query Parameters

  • accountIdstring · required
  • userIdstring
  • limitinteger · max: 100
    Default: 50
  • offsetinteger
    Default: 0

Get Conversations › Headers

  • Authorizationstring · required

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

Get Conversations › Responses

OK

  • successboolean
  • conversationsobject[]
  • paginationobject

Create Conversation

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

Create Conversation › Headers

  • Authorizationstring · required

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

Create Conversation › Request Body

  • accountIdstring · required
  • prospectIdsstring[] · required
  • userIdstring · required
  • identityIdstring · required
  • fromNumberDbstring · required
  • identityEmailstring · email · required
  • groupNamestring

Create Conversation › Responses

Created

  • successboolean
  • conversationIdstring
  • conversationobject
  • twilioConversationSidstring
  • metaobject

Get Specific Conversation

GET
https://api.hiringcenterpro.com/v2
/conversations/{conversationId}

Get Specific Conversation › path Parameters

  • conversationIdstring · required

Get Specific Conversation › query Parameters

  • accountIdstring · required

Get Specific Conversation › Headers

  • Authorizationstring · required

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

Get Specific Conversation › Responses

OK

  • successboolean
  • conversationobject

Update Conversation Name

PATCH
https://api.hiringcenterpro.com/v2
/conversations/{conversationId}

Update Conversation Name › path Parameters

  • conversationIdstring · required

Update Conversation Name › Headers

  • Authorizationstring · required

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

Update Conversation Name › Request Body

  • namestring · required
  • accountIdstring

Update Conversation Name › Responses

OK

  • successboolean
  • conversationIdstring
  • messagestring

Add Participant

POST
https://api.hiringcenterpro.com/v2
/conversations/{conversationId}/participants

Add Participant › path Parameters

  • conversationIdstring · required

Add Participant › Headers

  • Authorizationstring · required

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

Add Participant › Request Body

  • prospectIdstring · required
  • accountIdstring

Add Participant › Responses

OK

  • successboolean
  • conversationIdstring
  • prospectIdstring
  • messagestring

Remove Participant

DELETE
https://api.hiringcenterpro.com/v2
/conversations/{conversationId}/participants/{prospectId}

Remove Participant › path Parameters

  • conversationIdstring · required
  • prospectIdstring · required

Remove Participant › Headers

  • Authorizationstring · required

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

Remove Participant › Responses

OK

  • successboolean
  • conversationIdstring
  • prospectIdstring
  • messagestring
NotesMessages