HiringCenter Pro
HiringCenter Pro API

Schemas

Error

  • errorstring
  • messagestring
  • retryAfterinteger | null
Additional properties are allowed

Prospect

  • idstring
  • firstNamestring
  • lastNamestring
  • emailstring | null · email
  • phonestring | null
  • currentStagestring | null
  • currentStageIdstring | null
  • labelsstring[]
  • titlestring | null
  • companystring | null
  • createdAtinteger | null · int64
  • updatedAtinteger | null · int64
Additional properties are allowed

Note

  • idstring
  • bodystring
  • createdAtinteger · int64
  • prospectIdstring
  • userIdstring
  • mentionsobject[]
  • pinboolean
  • fileUrlstring | null · uri
Additional properties are allowed

ConversationUserState

  • userIdstring
  • unreadCountinteger
  • lastSeenAtinteger · int64

Conversation

  • idstring
  • namestring
  • prospectIdsstring[]
  • groupboolean
  • createdAtinteger · int64
  • lastMessageAtinteger | null · int64
  • lastMessageContentstring | null
  • lastMessageInboundboolean | null
  • identityIdstring | null
  • connectlyNumberstring | null
  • connectlyEmailstring | null · email
  • membersstring[]
  • accountIdstring
  • usersobject
Additional properties are allowed

EmailSendRequest

  • accountIdstring · required
  • userIdstring · required
  • subjectstring · required
  • bodystring · required

    HTML content

  • prospectIdstring
  • tostring · email
  • identityIdstring
  • fromstring · email
  • friendlyNamestring
  • ccstring[]
  • bccstring[]
  • headersobject
  • sendboolean
    Default: true
  • inboundboolean
    Default: false

ApiKey

  • idstring · required
  • namestring · required
  • accountIdstring · required
  • permissionsstring[] · required
  • createdAtinteger · int64 · required
  • activeboolean · required

Task

  • idstring
  • prospectIdstring
  • taskstring
  • assignTostring
  • assignedBystring
  • createdBystring
  • createdAtinteger · int64
  • updatedAtinteger | null · int64
  • dueAtinteger | null · int64
  • completedAtinteger | null · int64
  • completedBystring | null
Additional properties are allowed

WebhookSubscription

  • subscriptionIdstring · required
  • hookIdstring · required
  • hookUrlstring · uri · required
  • eventTypestring · required

    One of prospect.created or prospect.updated

  • endpointSecretstring
  • subscribedboolean
  • createdAtinteger · int64
  • updatedAtinteger · int64