Advanced

Submit details of an inbound call to the CRM.

Changed on

This endpoint allows you to submit information about an inbound call to the CRM system. The request must include details such as the external call ID, call status, and involved phone numbers. This operation helps in logging and managing inbound call data within the CRM.

post/crm/extensions/calling/2026-09/inbound-call

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/extensions/calling/2026-09/inbound-call
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.highly_sensitive.write.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.sensitive.write.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.schemas.contacts.write

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

  • 2026-098bccef69948cRevision changes
    • info

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

    • info

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

  • 2026-0935046bde1057Revision changes
    • breaking

      the //// response's property format changed from int32 to int64 for status

    • breaking

      the //// response's property format changed from int32 to int64 for status

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      the endpoint scheme security private_apps_legacy was removed from the API

    • info

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

    • info

      the security scope crm.objects.contacts.sensitive.write.v2 was removed from the endpoint's security scheme oauth2