Advanced

POST /crm/extensions/calling/2026-03/inbound-call

Changed on

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/extensions/calling/2026-03/inbound-call
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Request body

callStartedTimestampstring date-time

The timestamp indicating when the call started, formatted as a date-time string.

createEngagementboolean required

Indicates whether an engagement should be created for the call.

durationSecondsinteger

The duration of the call in seconds.

engagementPropertiesobject required

Contains additional properties related to the engagement.

externalCallIdstring required

The unique identifier for the call from an external system.

finalCallStatus'BUSY' | 'CALLING_CRM_USER' | 'CANCELED' | 'COMPLETED' | 'CONNECTING' | 'FAILED' | 'HOLD' | 'IN_PROGRESS' | 'MISSED' | 'NO_ANSWER' | 'QUEUED' | 'RINGING' | 'UNKNOWN' required

The final status of the call, with accepted values including: BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, HOLD, IN_PROGRESS, MISSED, NO_ANSWER, QUEUED, RINGING, UNKNOWN.

potentialRecipientUserIdsinteger[] required
userIdinteger

The ID of the user associated with the call.

Response

successful operation

Changes

    • info

      api operation id post-/crm/extensions/calling/2026-03/inbound-call_/crm/v3/extensions/calling/inbound-call removed and replaced with post-/crm/extensions/calling/2026-03/inbound-call

    • info

      the security scope crm.objects.contacts.highly_sensitive.write was added to the endpoint's security scheme private_apps

    • info

      the security scope crm.schemas.contacts.write was removed from the endpoint's security scheme private_apps

    • info

      the security scope crm.objects.contacts.highly_sensitive.write was added to the endpoint's security scheme private_apps

    • info

      the security scope crm.schemas.contacts.write was removed from the endpoint's security scheme private_apps

Some revisions have not been checked yet.