Events 5 endpoints

POST /crm/v3/timeline/events

Creates an instance of a timeline event based on an event template. Once created, this event is immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via objectPropertyName, this call will also attempt to updates those properties, or add them if they don’t exist.

operationId: Events_createSingleEvent

Request Body

required

The timeline event definition.

application/json
schema TimelineEvent
Property Type Required
id string optional
utk string optional
email string optional
domain string optional
tokens object required
objectId string optional
extraData object optional
timestamp string optional
timelineIFrame object optional
url string required
width integer required
height integer required
linkLabel string required
headerLabel string required
eventTemplateId string required

Responses

default
201

successful operation

POST /crm/v3/timeline/events
POST /crm/v3/timeline/events/batch/create

Creates multiple instances of timeline events based on an event template. Once created, these event are immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via objectPropertyName, this call will also attempt to updates those properties, or add them if they don’t exist.

operationId: Events_createMultipleBatch

Request Body

required

The timeline event definition.

application/json
schema BatchInputTimelineEvent
Property Type Required
inputs array required
id string optional
utk string optional
email string optional
domain string optional
tokens object required
objectId string optional
extraData object optional
timestamp string optional
timelineIFrame object optional
url string required
width integer required
height integer required
linkLabel string required
headerLabel string required
eventTemplateId string required

Responses

default
200
201

successful operation

207

multiple statuses

POST /crm/v3/timeline/events/batch/create
GET /crm/v3/timeline/events/{eventTemplateId}/{eventId}

This returns the previously created event. It contains all existing info for the event, but not necessarily the CRM object.

operationId: Events_getEventById

Parameters

Name In Required Type Description
eventTemplateId path required string

The event template ID.

eventId path required string

The event ID.

Responses

default
200

successful operation

GET /crm/v3/timeline/events/{eventTemplateId}/{eventId}
GET /crm/v3/timeline/events/{eventTemplateId}/{eventId}/detail

This will take the detailTemplate from the event template and return an object rendering the specified event. If the template references extraData that isn’t found in the event, it will be ignored and we’ll render without it.

operationId: Events_renderDetailTemplate

Parameters

Name In Required Type Description
eventTemplateId path required string

The event template ID.

eventId path required string

The event ID.

Responses

default
200

successful operation

GET /crm/v3/timeline/events/{eventTemplateId}/{eventId}/detail
GET /crm/v3/timeline/events/{eventTemplateId}/{eventId}/render

This will take either the headerTemplate or detailTemplate from the event template and render for the specified event as HTML. If the template references extraData that isn’t found in the event, it will be ignored and we’ll render without it.

operationId: Events_renderingHtml

Parameters

Name In Required Type Description
eventTemplateId path required string

The event template ID.

eventId path required string

The event ID.

detail query optional boolean

Set to ‘true’, we want to render the detailTemplate instead of the headerTemplate.

Responses

default
200

successful operation

GET /crm/v3/timeline/events/{eventTemplateId}/{eventId}/render

Gdpr 8 endpoints

POST /crm/v3/objects/companies/gdpr-delete

Permanently delete a contact and all associated content to follow GDPR. Use optional property ‘idProperty’ set to ‘email’ to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.

operationId: Gdpr_permanentlyDeleteContact

Request Body

required
application/json
schema PublicGdprDeleteInput
Property Type Required
objectId string required
idProperty string optional

Responses

default
204

No content

POST /crm/v3/objects/companies/gdpr-delete
POST /crm/v3/objects/contacts/gdpr-delete

Permanently delete a contact and all associated content to follow GDPR. Use optional property ‘idProperty’ set to ‘email’ to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.

operationId: Gdpr_permanentlyDeleteContact

Request Body

required
application/json
schema PublicGdprDeleteInput
Property Type Required
objectId string required
idProperty string optional

Responses

default
204

No content

POST /crm/v3/objects/contacts/gdpr-delete
POST /crm/v3/objects/deals/gdpr-delete

Permanently delete a contact and all associated content to follow GDPR. Use optional property ‘idProperty’ set to ‘email’ to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.

operationId: Gdpr_permanentlyDeleteDeal

Request Body

required
application/json
schema PublicGdprDeleteInput
Property Type Required
objectId string required
idProperty string optional

Responses

default
204

No content

POST /crm/v3/objects/deals/gdpr-delete
POST /crm/v3/objects/feedback_submissions/gdpr-delete

Permanently delete a contact and all associated content to follow GDPR. Use optional property ‘idProperty’ set to ‘email’ to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.

operationId: Gdpr_permanentlyDeleteContact

Request Body

required
application/json
schema PublicGdprDeleteInput
Property Type Required
objectId string required
idProperty string optional

Responses

default
204

No content

POST /crm/v3/objects/feedback_submissions/gdpr-delete
POST /crm/v3/objects/line_items/gdpr-delete

Permanently delete a contact and all associated content to follow GDPR. Use optional property ‘idProperty’ set to ‘email’ to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.

operationId: Gdpr_deleteContactContent

Request Body

required
application/json
schema PublicGdprDeleteInput
Property Type Required
objectId string required
idProperty string optional

Responses

default
204

No content

POST /crm/v3/objects/line_items/gdpr-delete
POST /crm/v3/objects/products/gdpr-delete

Permanently delete a contact and all associated content to follow GDPR. Use optional property ‘idProperty’ set to ‘email’ to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.

operationId: Gdpr_deleteContact

Request Body

required
application/json
schema PublicGdprDeleteInput
Property Type Required
objectId string required
idProperty string optional

Responses

default
204

No content

POST /crm/v3/objects/products/gdpr-delete
POST /crm/v3/objects/quotes/gdpr-delete

Permanently delete a contact and all associated content to follow GDPR. Use optional property ‘idProperty’ set to ‘email’ to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.

operationId: Gdpr_permanentlyDeleteContact

Request Body

required
application/json
schema PublicGdprDeleteInput
Property Type Required
objectId string required
idProperty string optional

Responses

default
204

No content

POST /crm/v3/objects/quotes/gdpr-delete
POST /crm/v3/objects/tickets/gdpr-delete

Permanently delete a contact and all associated content to follow GDPR. Use optional property ‘idProperty’ set to ‘email’ to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.

operationId: Gdpr_permanentlyDeleteContact

Request Body

required
application/json
schema PublicGdprDeleteInput
Property Type Required
objectId string required
idProperty string optional

Responses

default
204

No content

POST /crm/v3/objects/tickets/gdpr-delete

Groups 5 endpoints

GET /crm/v3/properties/{objectType}/groups

Read all existing property groups for the specified object type and HubSpot account.

operationId: Groups_readAllProperty

Parameters

Name In Required Type Description
objectType path required string

Responses

default
200

successful operation

GET /crm/v3/properties/{objectType}/groups
POST /crm/v3/properties/{objectType}/groups

Create and return a copy of a new property group.

operationId: Groups_createCopy

Parameters

Name In Required Type Description
objectType path required string

Request Body

required
application/json
schema PropertyGroupCreate
Property Type Required
name string required
label string required
displayOrder integer optional

Responses

default
201

successful operation

POST /crm/v3/properties/{objectType}/groups
DELETE /crm/v3/properties/{objectType}/groups/{groupName}

Move a property group identified by {groupName} to the recycling bin.

operationId: Groups_archivePropertyGroup

Parameters

Name In Required Type Description
objectType path required string
groupName path required string

Responses

default
204

No content

DELETE /crm/v3/properties/{objectType}/groups/{groupName}
GET /crm/v3/properties/{objectType}/groups/{groupName}

Read a property group identified by {groupName}.

operationId: Groups_readPropertyGroup

Parameters

Name In Required Type Description
objectType path required string
groupName path required string

Responses

default
200

successful operation

GET /crm/v3/properties/{objectType}/groups/{groupName}
PATCH /crm/v3/properties/{objectType}/groups/{groupName}

Perform a partial update of a property group identified by {groupName}. Provided fields will be overwritten.

operationId: Groups_updatePropertyGroup

Parameters

Name In Required Type Description
objectType path required string
groupName path required string

Request Body

required
application/json
schema PropertyGroupUpdate
Property Type Required
label string optional
displayOrder integer optional

Responses

default
200

successful operation

PATCH /crm/v3/properties/{objectType}/groups/{groupName}

Owners 2 endpoints

GET /crm/v3/owners
operationId: Owners_getPage

Parameters

Name In Required Type Description
email query optional string

Filter by email address (optional)

after query optional string

The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.

limit query optional integer

The maximum number of results to display per page.

archived query optional boolean

Whether to return only results that have been archived.

Responses

default
200

successful operation

GET /crm/v3/owners
GET /crm/v3/owners/{ownerId}
operationId: Owners_getById

Parameters

Name In Required Type Description
ownerId path required integer
idProperty query optional string
archived query optional boolean

Whether to return only results that have been archived.

Responses

default
200

successful operation

GET /crm/v3/owners/{ownerId}

Pipelineaudits 1 endpoints

GET /crm/v3/pipelines/{objectType}/{pipelineId}/audit

Return a reverse chronological list of all mutations that have occurred on the pipeline identified by {pipelineId}.

operationId: PipelineAudits_getByPipelineId

Parameters

Name In Required Type Description
objectType path required string
pipelineId path required string

Responses

default
200

successful operation

GET /crm/v3/pipelines/{objectType}/{pipelineId}/audit

Pipelinestageaudits 1 endpoints

GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit

Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by {stageId}.

operationId: PipelineStageAudits_getStageAudit

Parameters

Name In Required Type Description
objectType path required string
stageId path required string

Responses

default
200

successful operation

GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit

Pipelinestages 6 endpoints

GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages

Return all the stages associated with the pipeline identified by {pipelineId}.

operationId: PipelineStages_getAll

Parameters

Name In Required Type Description
objectType path required string
pipelineId path required string

Responses

default
200

successful operation

GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages
POST /crm/v3/pipelines/{objectType}/{pipelineId}/stages

Create a new stage associated with the pipeline identified by {pipelineId}. The entire stage object, including its unique ID, will be returned in the response.

operationId: PipelineStages_createStageObject

Parameters

Name In Required Type Description
objectType path required string
pipelineId path required string

Request Body

required
application/json
schema PipelineStageInput
Property Type Required
label string required
metadata object required
displayOrder integer required

Responses

default
201

successful operation

POST /crm/v3/pipelines/{objectType}/{pipelineId}/stages
DELETE /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}

Delete the pipeline stage identified by {stageId} associated with the pipeline identified by {pipelineId}.

operationId: PipelineStages_deleteStage

Parameters

Name In Required Type Description
objectType path required string
pipelineId path required string
stageId path required string

Responses

default
204

No content

DELETE /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}
GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}

Return the stage identified by {stageId} associated with the pipeline identified by {pipelineId}.

operationId: PipelineStages_getById

Parameters

Name In Required Type Description
objectType path required string
pipelineId path required string
stageId path required string

Responses

default
200

successful operation

GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}
PATCH /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}

Perform a partial update of the pipeline stage identified by {stageId} associated with the pipeline identified by {pipelineId}. Any properties not included in this update will keep their existing values. The updated stage will be returned in the response.

operationId: PipelineStages_updateStageById

Parameters

Name In Required Type Description
objectType path required string
pipelineId path required string
stageId path required string

Request Body

required
application/json
schema PipelineStagePatchInput
Property Type Required
label string optional
archived boolean optional
metadata object required
displayOrder integer optional

Responses

default
200

successful operation

PATCH /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}
PUT /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}

Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.

operationId: PipelineStages_replaceStageObject

Parameters

Name In Required Type Description
objectType path required string
pipelineId path required string
stageId path required string

Request Body

required
application/json
schema PipelineStageInput
Property Type Required
label string required
metadata object required
displayOrder integer required

Responses

default
200

successful operation

PUT /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}

Pipelines 6 endpoints

GET /crm/v3/pipelines/{objectType}

Return all pipelines for the object type specified by {objectType}.

operationId: Pipelines_getAll

Parameters

Name In Required Type Description
objectType path required string

Responses

default
200

successful operation

GET /crm/v3/pipelines/{objectType}
POST /crm/v3/pipelines/{objectType}

Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.

operationId: Pipelines_createNewPipelineObject

Parameters

Name In Required Type Description
objectType path required string

Request Body

required
application/json
schema PipelineInput
Property Type Required
label string required
stages array required
label string required
metadata object required
displayOrder integer required
displayOrder integer required

Responses

default
201

successful operation

POST /crm/v3/pipelines/{objectType}
DELETE /crm/v3/pipelines/{objectType}/{pipelineId}

Delete the pipeline identified by {pipelineId}.

operationId: Pipelines_removeById

Parameters

Name In Required Type Description
objectType path required string
pipelineId path required string
validateReferencesBeforeDelete query optional boolean
validateDealStageUsagesBeforeDelete query optional boolean

Responses

default
204

No content

DELETE /crm/v3/pipelines/{objectType}/{pipelineId}
GET /crm/v3/pipelines/{objectType}/{pipelineId}

Return a single pipeline object identified by its unique {pipelineId}.

operationId: Pipelines_getById

Parameters

Name In Required Type Description
objectType path required string
pipelineId path required string

Responses

default
200

successful operation

GET /crm/v3/pipelines/{objectType}/{pipelineId}
PATCH /crm/v3/pipelines/{objectType}/{pipelineId}

Perform a partial update of the pipeline identified by {pipelineId}. The updated pipeline will be returned in the response.

operationId: Pipelines_updatePipelineById

Parameters

Name In Required Type Description
objectType path required string
pipelineId path required string
validateReferencesBeforeDelete query optional boolean
validateDealStageUsagesBeforeDelete query optional boolean

Request Body

required
application/json
schema PipelinePatchInput
Property Type Required
label string optional
archived boolean optional
displayOrder integer optional

Responses

default
200

successful operation

PATCH /crm/v3/pipelines/{objectType}/{pipelineId}
PUT /crm/v3/pipelines/{objectType}/{pipelineId}

Replace all the properties of an existing pipeline with the values provided. This will overwrite any existing pipeline stages. The updated pipeline will be returned in the response.

operationId: Pipelines_replacePipelineObject

Parameters

Name In Required Type Description
objectType path required string
pipelineId path required string
validateReferencesBeforeDelete query optional boolean
validateDealStageUsagesBeforeDelete query optional boolean

Request Body

required
application/json
schema PipelineInput
Property Type Required
label string required
stages array required
label string required
metadata object required
displayOrder integer required
displayOrder integer required

Responses

default
200

successful operation

PUT /crm/v3/pipelines/{objectType}/{pipelineId}

Publicimports 1 endpoints

GET /crm/v3/imports/{importId}/errors
operationId: PublicImports_getErrorDetails

Parameters

Name In Required Type Description
after query optional string

The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.

limit query optional integer

The maximum number of results to display per page.

importId path required integer

Responses

default
200

successful operation

GET /crm/v3/imports/{importId}/errors

Publicobject 9 endpoints

POST /crm/v3/objects/companies/merge
operationId: PublicObject_mergeCompaniesSameType

Request Body

required
application/json
schema PublicMergeInput
Property Type Required
objectIdToMerge string required
primaryObjectId string required

Responses

default
200

successful operation

POST /crm/v3/objects/companies/merge
POST /crm/v3/objects/contacts/merge
operationId: PublicObject_mergeContactsSameType

Request Body

required
application/json
schema PublicMergeInput
Property Type Required
objectIdToMerge string required
primaryObjectId string required

Responses

default
200

successful operation

POST /crm/v3/objects/contacts/merge
POST /crm/v3/objects/deals/merge
operationId: PublicObject_mergeDealsSameType

Request Body

required
application/json
schema PublicMergeInput
Property Type Required
objectIdToMerge string required
primaryObjectId string required

Responses

default
200

successful operation

POST /crm/v3/objects/deals/merge
POST /crm/v3/objects/feedback_submissions/merge
operationId: PublicObject_mergeFeedbackSubmissions

Request Body

required
application/json
schema PublicMergeInput
Property Type Required
objectIdToMerge string required
primaryObjectId string required

Responses

default
200

successful operation

POST /crm/v3/objects/feedback_submissions/merge
POST /crm/v3/objects/line_items/merge
operationId: PublicObject_mergeLineItemsSameType

Request Body

required
application/json
schema PublicMergeInput
Property Type Required
objectIdToMerge string required
primaryObjectId string required

Responses

default
200

successful operation

POST /crm/v3/objects/line_items/merge
POST /crm/v3/objects/products/merge
operationId: PublicObject_mergeProductsSameType

Request Body

required
application/json
schema PublicMergeInput
Property Type Required
objectIdToMerge string required
primaryObjectId string required

Responses

default
200

successful operation

POST /crm/v3/objects/products/merge
POST /crm/v3/objects/quotes/merge
operationId: PublicObject_mergeTwoQuotesSameType

Request Body

required
application/json
schema PublicMergeInput
Property Type Required
objectIdToMerge string required
primaryObjectId string required

Responses

default
200

successful operation

POST /crm/v3/objects/quotes/merge
POST /crm/v3/objects/tickets/merge
operationId: PublicObject_mergeTicketsSameType

Request Body

required
application/json
schema PublicMergeInput
Property Type Required
objectIdToMerge string required
primaryObjectId string required

Responses

default
200

successful operation

POST /crm/v3/objects/tickets/merge
POST /crm/v3/objects/{objectType}/merge
operationId: PublicObject_mergeObjectsWithType

Parameters

Name In Required Type Description
objectType path required string

Request Body

required
application/json
schema PublicMergeInput
Property Type Required
objectIdToMerge string required
primaryObjectId string required

Responses

default
200

successful operation

POST /crm/v3/objects/{objectType}/merge

Recordingsettings 3 endpoints

GET /crm/v3/extensions/calling/{appId}/settings/recording
operationId: RecordingSettings_getByAppId

Parameters

Name In Required Type Description
appId path required integer

Responses

default
200

successful operation

GET /crm/v3/extensions/calling/{appId}/settings/recording
PATCH /crm/v3/extensions/calling/{appId}/settings/recording
operationId: RecordingSettings_updateCallingSettings

Parameters

Name In Required Type Description
appId path required integer

Request Body

required
application/json
schema RecordingSettingsPatchRequest
Property Type Required
urlToRetrieveAuthedRecording string optional

Responses

default
200

successful operation

PATCH /crm/v3/extensions/calling/{appId}/settings/recording
POST /crm/v3/extensions/calling/{appId}/settings/recording
operationId: RecordingSettings_setCallRecording

Parameters

Name In Required Type Description
appId path required integer

Request Body

required
application/json
schema RecordingSettingsRequest
Property Type Required
urlToRetrieveAuthedRecording string required

Responses

default
200

successful operation

POST /crm/v3/extensions/calling/{appId}/settings/recording
Load more endpoints