Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
HubSpot Engagements V2 (Independent Publisher) (Preview)
HubSpot Engagements is used for keeping your CRM records up-to-date on any interactions that take place outside of HubSpot. Activity reporting in the CRM also feeds off of this data.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Connector Metadata | |
|---|---|
| Publisher | Troy Taylor |
| Website | https://www.hubspot.com/products/crm |
| Privacy policy | https://legal.hubspot.com/privacy-policy |
| Categories | Sales and CRM;Communication |
HubSpot Engagements V2
HubSpot Engagements is used for keeping your CRM records up-to-date on any interactions that take place outside of HubSpot. Activity reporting in the CRM also feeds off of this data.
Publisher: Troy Taylor, Hitachi Solutions
Prerequisites
You must have an account with HubSpot and be a Super Admin.
Obtaining Credentials
Once you are logged in to your account, go to Settings -> Account Setup -> Integrations -> Private Apps. You will need to create a private app and assign it only the scopes you will use actions for. Once your private app is created, you will have an access token in the Auth section of the private app.
Supported Operations
Create batch of calls
Creates a batch of calls.
Get batch of calls
Retrieves a batch of calls by internal ID, or unique property values.
Update batch of calls
Updates a batch of calls.
Archive batch of calls
Archives a batch of calls by ID.
List calls
Retrieves a page of calls. Control what is returned via the properties query param.
Create a call
Creates a call with the given properties and return a copy of the object, including the ID.
Read an object
Retrieves an object identified by callId. callId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Archive an object
Moves an object identified by callId to the recycling bin.
Update an object
Performs a partial update of an object identified by callId. callId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Merge two calls
Merges two calls with same type.
Delete a call - GDPR
Permanently deletes a call 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.
Search calls
Retrieves a list of calls.
Create a batch of emails
Creates a batch of emails.
Get batch of emails
Retrieves a batch of emails by internal ID, or unique property values.
Archive batch of emails
Archives a batch of emails by ID.
Update batch of emails
Updates a batch of emails.
List emails
Retrieves a page of emails. Control what is returned via the properties query param.
Create an email
Creates a email with the given properties and return a copy of the object, including the ID.
Get email
Retrieves an object identified by emailId. emailId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Archive email
Moves an object identified by emailId to the recycling bin.
Update email
Performs a partial update of an object identified by emailId. emailId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Merge two emails
Merges two emails with same type.
Delete an email - GDPR
Permanently deletes an email 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.
Search email
Retrieve a list of emails.
Update batch of meetings
Updates a batch of meetings.
Archive batch of meetings
Archives a batch of meetings by ID.
Get batch of meetings
Retrieves a batch of meetings by internal ID, or unique property values.
Create a batch of meetings
Creates a batch of meetings.
Get meeting
Retrieves an object identified by meetingId. meetingId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Archive meeting
Moves an object identified by meetingId to the recycling bin.
Update meeting
Performs a partial update of an object identified by meetingId. meetingId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
List meetings
Retrieves a page of meetings. Control what is returned via the properties query param.
Create meeting
Creates a meeting with the given properties and return a copy of the object, including the ID.
Merge two meetings
Merges two meetings with same type.
Delete a meeting - GDPR
Permanently deletes a meeting 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.
Search meetings
Retrieve a list of meetings.
Get batch of notes
Retrieves a batch of notes by internal ID, or unique property values.
Archive batch of notes
Archives a batch of notes by ID.
Update batch of notes
Updates a batch of notes.
Create a batch of notes
Creates a batch of notes.
List notes
Retrieves a page of notes. Control what is returned via the properties query param.
Create note
Creates a note with the given properties and return a copy of the object, including the ID.
Get note
Retrieves an object identified by noteId. noteId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Archive note
Moves an object identified by noteId to the recycling bin.
Update note
Performs a partial update of an object identified by noteId. noteId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Merge two notes
Merges two notes with same type.
Delete a note - GDPR
Permanently deletes a note 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.
Search notes
Retrieves a list of notes.
Get batch of postal mail
Retrieves a batch of postal mail by internal ID, or unique property values.
Archive batch of postal mail
Archives a batch of postal mail by ID.
Create a batch of postal mail
Creates a batch of postal mail.
Update batch of postal mail
Updates a batch of postal mail.
List postal mail
Retrieves a page of postal mail. Control what is returned via the properties query param.
Create postal mail
Creates a postal mail with the given properties and return a copy of the object, including the ID.
Get postal mail
Retrieves an object identified by postalMailId. postalMailId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Archive postal mail
Moves an object identified by postalMailId to the recycling bin.
Update postal mail
Performs a partial update of an object identified by postalMailId. postalMailId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Merge two postal mail
Merges two postal mail with same type.
Delete a postal mail - GDPR
Permanently deletes a postal mail 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.
Search postal mail
Retrieve a list of postal mail.
Archive batch of tasks
Archives a batch of tasks by ID.
Create a batch of tasks
Creates a batch of tasks.
Update batch of tasks
Updates a batch of tasks.
Get batch of tasks
Retrieves a batch of tasks by internal ID, or unique property values.
Get task
Retrieves an object identified by taskId. taskId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Archive task
Moves an object identified by taskId to the recycling bin.
Update task
Performs a partial update of an object identified by taskId. taskId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
List tasks
Retrieves a page of tasks. Control what is returned via the properties query param.
Create task
Creates a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided.
Merge two tasks
Merges two tasks with same type.
Delete a task - GDPR
Permanently deletes a task 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.
Search tasks
Retrieve a list of tasks.
Update batch of communications
Updates a batch of communications.
Archive batch of communications
Archives a batch of communications by ID.
Create a batch of communications
Creates a batch of communications.
Get batch of communications
Retrieves a batch of communications by internal ID, or unique property values.
List communications
Retrieves a page of communications. Control what is returned via the properties query param.
Create communication
Creates a communication with the given properties and return a copy of the object, including the ID.
Get communication
Retrieves an object identified by communicationId. communicationId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Archive communication
Moves an object identified by communicationId to the recycling bin.
Update communication
Performs a partial update of an object identified by communicationId. communicationId refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Merge two communications
Merges two communications with same type.
Delete a communication - GDPR
Permanently deletes a communication 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.
Search communications
Retrieve a list of communications.
Known Issues and Limitations
There are no known issues at this time.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Access Token (in the form 'Bearer YOUR_ACCESS_TOKEN') | securestring | The Access Token (in the form 'Bearer YOUR_ACCESS_TOKEN') for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Archive an object |
Moves an object identified by 'callId' to the recycling bin. |
| Archive batch of calls |
Archives a batch of calls by ID. |
| Archive batch of communications |
Archives a batch of communications by ID. |
| Archive batch of emails |
Archives a batch of emails by ID. |
| Archive batch of meetings |
Archives a batch of meetings by ID. |
| Archive batch of notes |
Archives a batch of notes by ID. |
| Archive batch of postal mail |
Archives a batch of postal mail by ID. |
| Archive batch of tasks |
Archives a batch of tasks by ID. |
| Archive communication |
Moves an object identified by 'communicationId' to the recycling bin. |
| Archive email |
Moves an object identified by 'emailId' to the recycling bin. |
| Archive meeting |
Moves an object identified by 'meetingId' to the recycling bin. |
| Archive note |
Moves an object identified by 'noteId' to the recycling bin. |
| Archive postal mail |
Moves an object identified by 'postalMailId' to the recycling bin. |
| Archive task |
Moves an object identified by 'taskId' to the recycling bin. |
| Create a batch of communications |
Creates a batch of communications. |
| Create a batch of emails |
Creates a batch of emails. |
| Create a batch of meetings |
Creates a batch of meetings. |
| Create a batch of notes |
Creates a batch of notes. |
| Create a batch of postal mail |
Creates a batch of postal mail. |
| Create a batch of tasks |
Creates a batch of tasks. |
| Create a call |
Creates a call with the given properties and return a copy of the object, including the ID. |
| Create an email |
Creates an email with the given properties and return a copy of the object, including the ID. |
| Create batch of calls |
Creates a batch of calls. |
| Create communication |
Creates a communication with the given properties and return a copy of the object, including the ID. |
| Create meeting |
Creates a meeting with the given properties and return a copy of the object, including the ID. |
| Create note |
Creates a note with the given properties and return a copy of the object, including the ID. |
| Create postal mail |
Creates a postal mail with the given properties and return a copy of the object, including the ID. |
| Create task |
Creates a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided. |
| Delete a call - GDPR |
Permanently deletes a call 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. |
| Delete a communication - GDPR |
Permanently deletes a communication 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. |
| Delete a meeting - GDPR |
Permanently deletes a meeting 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. |
| Delete a note - GDPR |
Permanently deletes a note 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. |
| Delete a postal mail - GDPR |
Permanently deletes a postal mail 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. |
| Delete a task - GDPR |
Permanently deletes a task 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. |
| Delete an email - GDPR |
Permanently deletes an email 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. |
| Get batch of calls |
Retrieves a batch of calls by internal ID, or unique property values. |
| Get batch of communications |
Retrieves a batch of communications by internal ID, or unique property values. |
| Get batch of emails |
Retrieves a batch of emails by internal ID, or unique property values. |
| Get batch of meetings |
Retrieves a batch of meetings by internal ID, or unique property values. |
| Get batch of notes |
Retrieves a batch of notes by internal ID, or unique property values. |
| Get batch of postal mail |
Retrieves a batch of postal mail by internal ID, or unique property values. |
| Get batch of tasks |
Retrieves a batch of tasks by internal ID, or unique property values. |
| Get communication |
Retrieves an object identified by 'communicationId'. 'communicationId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| Get email |
Retrieves an object identified by 'emailId'. 'emailId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| Get meeting |
Retrieves an object identified by 'meetingId'. 'meetingId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| Get note |
Retrieves an object identified by 'noteId'. 'noteId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| Get postal mail |
Retrieves an object identified by 'postalMailId'. 'postalMailId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| Get task |
Retrieves an object identified by 'taskId'. 'taskId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| List calls |
Retrieves a page of calls. Control what is returned via the |
| List communications |
Retrieves a page of communications. Control what is returned via the |
| List emails |
Retrieves a page of emails. Control what is returned via the |
| List meetings |
Retrieves a page of meetings. Control what is returned via the |
| List notes |
Retrieves a page of notes. Control what is returned via the |
| List postal mail |
Retrieves a page of postal mail. Control what is returned via the |
| List tasks |
Retrieves a page of tasks. Control what is returned via the |
| Merge two calls |
Merges two calls with same type. |
| Merge two communications |
Merges two communications with same type. |
| Merge two emails |
Merges two emails with same type. |
| Merge two meetings |
Merges two meetings with same type. |
| Merge two notes |
Merges two notes with same type. |
| Merge two postal mail |
Merges two postal mail with same type. |
| Merge two tasks |
Merges two tasks with same type. |
| Read an object |
Retrieves an object identified by 'callId'. 'callId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| Search calls |
Retrieves a list of calls. |
| Search communications |
Retrieve a list of communications. |
| Search email |
Retrieve a list of emails. |
| Search meetings |
Retrieve a list of meetings. |
| Search notes |
Retrieves a list of notes. |
| Search postal mail |
Retrieve a list of postal mail. |
| Search tasks |
Retrieve a list of tasks. |
| Update an object |
Performs a partial update of an object identified by 'callId'. 'callId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| Update batch of calls |
Updates a batch of calls. |
| Update batch of communications |
Updates a batch of communications. |
| Update batch of emails |
Updates a batch of emails. |
| Update batch of meetings |
Updates a batch of meetings. |
| Update batch of notes |
Updates a batch of notes. |
| Update batch of postal mail |
Updates a batch of postal mail. |
| Update batch of tasks |
Updates a batch of tasks. |
| Update communication |
Performs a partial update of an object identified by 'communicationId'. 'communicationId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| Update email |
Performs a partial update of an object identified by 'emailId'. 'emailId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| Update meeting |
Performs a partial update of an object identified by 'meetingId'. 'meetingId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| Update note |
Performs a partial update of an object identified by 'noteId'. 'noteId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| Update postal mail |
Performs a partial update of an object identified by 'postalMailId'. 'postalMailId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
| Update task |
Performs a partial update of an object identified by 'taskId'. 'taskId' refers to the internal object ID by default, or optionally any unique property value as specified by the |
Archive an object
- Operation ID:
- Archive
Moves an object identified by 'callId' to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Call ID
|
callId | True | string |
The call identifier. |
Returns
- response
- string
Archive batch of calls
- Operation ID:
- ArchiveABatchOfCallsById
Archives a batch of calls by ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive batch of communications
- Operation ID:
- ArchiveABatchOfCommunicationsById
Archives a batch of communications by ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive batch of emails
- Operation ID:
- ArchiveABatchOfEmailsById
Archives a batch of emails by ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive batch of meetings
- Operation ID:
- ArchiveABatchOfMeetingsById
Archives a batch of meetings by ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive batch of notes
- Operation ID:
- ArchiveABatchOfNotesById
Archives a batch of notes by ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive batch of postal mail
- Operation ID:
- ArchiveABatchOfPostalMailById
Archives a batch of postal mail by ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive batch of tasks
- Operation ID:
- ArchiveABatchOfTasksById
Archives a batch of tasks by ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive communication
- Operation ID:
- Archive79
Moves an object identified by 'communicationId' to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Communication ID
|
communicationId | True | string |
The communication identifier. |
Returns
- response
- string
Archive email
- Operation ID:
- Archive19
Moves an object identified by 'emailId' to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Email ID
|
emailId | True | string |
The email identifier. |
Returns
- response
- string
Archive meeting
- Operation ID:
- Archive29
Moves an object identified by 'meetingId' to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Meeting ID
|
meetingId | True | string |
The meeting identifier. |
Returns
- response
- string
Archive note
- Operation ID:
- Archive43
Moves an object identified by 'noteId' to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Note ID
|
noteId | True | string |
The note identifier. |
Returns
- response
- string
Archive postal mail
- Operation ID:
- Archive55
Moves an object identified by 'postalMailId' to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Postal Mail ID
|
postalMailId | True | string |
The postal mail identifier. |
Returns
- response
- string
Archive task
- Operation ID:
- ArchiveTask
Moves an object identified by 'taskId' to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task ID
|
taskId | True | string |
The task identifier. |
Returns
- response
- string
Create a batch of communications
- Operation ID:
- CreateABatchOfCommunications
Creates a batch of communications.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of emails
- Operation ID:
- CreateABatchOfEmails
Creates a batch of emails.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of meetings
- Operation ID:
- CreateABatchOfMeetings
Creates a batch of meetings.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of notes
- Operation ID:
- CreateABatchOfNotes
Creates a batch of notes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of postal mail
- Operation ID:
- CreateABatchOfPostalMail
Creates a batch of postal mail.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of tasks
- Operation ID:
- CreateABatchOfTasks
Creates a batch of tasks.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a call
- Operation ID:
- CreateCall
Creates a call with the given properties and return a copy of the object, including the ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create an email
- Operation ID:
- CreateEmail
Creates an email with the given properties and return a copy of the object, including the ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create batch of calls
- Operation ID:
- CreateABatchOfCalls
Creates a batch of calls.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create communication
- Operation ID:
- CreateCoomunication
Creates a communication with the given properties and return a copy of the object, including the ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create meeting
- Operation ID:
- CreateMeeting
Creates a meeting with the given properties and return a copy of the object, including the ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create note
- Operation ID:
- CreateNote
Creates a note with the given properties and return a copy of the object, including the ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create postal mail
- Operation ID:
- CreatePostalMail
Creates a postal mail with the given properties and return a copy of the object, including the ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create task
- Operation ID:
- Create68
Creates a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Delete a call - GDPR
- Operation ID:
- GdprDelete
Permanently deletes a call 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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a communication - GDPR
- Operation ID:
- GdprDelete82
Permanently deletes a communication 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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a meeting - GDPR
- Operation ID:
- GdprDelete34
Permanently deletes a meeting 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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a note - GDPR
- Operation ID:
- GdprDelete46
Permanently deletes a note 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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a postal mail - GDPR
- Operation ID:
- GdprDelete58
Permanently deletes a postal mail 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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a task - GDPR
- Operation ID:
- GdprDelete70
Permanently deletes a task 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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete an email - GDPR
- Operation ID:
- GdprDelete22
Permanently deletes an email 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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Get batch of calls
- Operation ID:
- ReadABatchOfCallsByInternalIdOrUniquePropertyValues
Retrieves a batch of calls by internal ID, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get batch of communications
- Operation ID:
- ReadABatchOfCommunicationsByInternalIdOrUniquePropertyValues
Retrieves a batch of communications by internal ID, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get batch of emails
- Operation ID:
- ReadABatchOfEmailsByInternalIdOrUniquePropertyValues
Retrieves a batch of emails by internal ID, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get batch of meetings
- Operation ID:
- ReadABatchOfMeetingsByInternalIdOrUniquePropertyValues
Retrieves a batch of meetings by internal ID, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get batch of notes
- Operation ID:
- ReadABatchOfNotesByInternalIdOrUniquePropertyValues
Retrieves a batch of notes by internal ID, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get batch of postal mail
- Operation ID:
- ReadABatchOfPostalMailByInternalIdOrUniquePropertyValues
Retrieves a batch of postal mail by internal ID, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get batch of tasks
- Operation ID:
- ReadABatchOfTasksByInternalIdOrUniquePropertyValues
Retrieves a batch of tasks by internal ID, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get communication
- Operation ID:
- ReadCommunication
Retrieves an object identified by 'communicationId'. 'communicationId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Communication ID
|
communicationId | True | string |
The communication identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get email
- Operation ID:
- ReadEmail
Retrieves an object identified by 'emailId'. 'emailId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Email ID
|
emailId | True | string |
The email identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get meeting
- Operation ID:
- ReadMeeting
Retrieves an object identified by 'meetingId'. 'meetingId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Meeting ID
|
meetingId | True | string |
The meeting identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get note
- Operation ID:
- ReadNote
Retrieves an object identified by 'noteId'. 'noteId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Note ID
|
noteId | True | string |
The note identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get postal mail
- Operation ID:
- ReadPostalMail
Retrieves an object identified by 'postalMailId'. 'postalMailId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Postal Mail ID
|
postalMailId | True | string |
The postal mail identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get task
- Operation ID:
- ReadTask
Retrieves an object identified by 'taskId'. 'taskId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Task ID
|
taskId | True | string |
The task identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
List calls
- Operation ID:
- List
Retrieves a page of calls. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
List communications
- Operation ID:
- ListCommunications
Retrieves a page of communications. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
List emails
- Operation ID:
- ListEmails
Retrieves a page of emails. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
List meetings
- Operation ID:
- ListMeetings
Retrieves a page of meetings. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
List notes
- Operation ID:
- ListNotes
Retrieves a page of notes. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
List postal mail
- Operation ID:
- ListPostalMail
Retrieves a page of postal mail. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
List tasks
- Operation ID:
- List67
Retrieves a page of tasks. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
Merge two calls
- Operation ID:
- MergeTwoCallsWithSameType
Merges two calls with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary Object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two communications
- Operation ID:
- MergeTwoCommunicationsWithSameType
Merges two communications with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary Object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two emails
- Operation ID:
- MergeTwoEmailsWithSameType
Merges two emails with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary Object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two meetings
- Operation ID:
- MergeTwoMeetingsWithSameType
Merges two meetings with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary Object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two notes
- Operation ID:
- MergeTwoNotesWithSameType
Merges two notes with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary Object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two postal mail
- Operation ID:
- MergeTwoPostalMailWithSameType
Merges two postal mail with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary Object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two tasks
- Operation ID:
- MergeTwoTasksWithSameType
Merges two tasks with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary Object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Read an object
- Operation ID:
- ReadObject
Retrieves an object identified by 'callId'. 'callId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Call ID
|
callId | True | string |
The call identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Search calls
- Operation ID:
- Post-_crm_v3_objects_calls_search
Retrieves a list of calls.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | integer |
The total. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
Search communications
- Operation ID:
- Post-_crm_v3_objects_communications_search
Retrieve a list of communications.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | integer |
The total. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
Search email
- Operation ID:
- Post-_crm_v3_objects_emails_search
Retrieve a list of emails.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | integer |
The total. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
Search meetings
- Operation ID:
- Post-_crm_v3_objects_meetings_search
Retrieve a list of meetings.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | integer |
The total. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
Search notes
- Operation ID:
- Post-_crm_v3_objects_notes_search
Retrieves a list of notes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | integer |
The total. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
Search postal mail
- Operation ID:
- Post-_crm_v3_objects_postalMail_search
Retrieve a list of postal mail.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | integer |
The total. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
Search tasks
- Operation ID:
- Post-_crm_v3_objects_tasks_search
Retrieve a list of tasks.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | integer |
The total. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
Update an object
- Operation ID:
- UpdateObject
Performs a partial update of an object identified by 'callId'. 'callId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Call ID
|
callId | True | string |
The call identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update batch of calls
- Operation ID:
- UpdateABatchOfCalls
Updates a batch of calls.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update batch of communications
- Operation ID:
- UpdateABatchOfCommunications
Updates a batch of communications.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update batch of emails
- Operation ID:
- UpdateABatchOfEmails
Updates a batch of emails.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update batch of meetings
- Operation ID:
- UpdateABatchOfMeetings
Updates a batch of meetings.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update batch of notes
- Operation ID:
- UpdateABatchOfNotes
Updates a batch of notes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update batch of postal mail
- Operation ID:
- UpdateABatchOfPostalMail
Updates a batch of postal mail.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update batch of tasks
- Operation ID:
- UpdateABatchOfTasks
Updates a batch of tasks.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update communication
- Operation ID:
- Update80
Performs a partial update of an object identified by 'communicationId'. 'communicationId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Communication ID
|
communicationId | True | string |
The communication identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update email
- Operation ID:
- Update20
Performs a partial update of an object identified by 'emailId'. 'emailId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Email ID
|
emailId | True | string |
The email identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update meeting
- Operation ID:
- UpdateMeeting
Performs a partial update of an object identified by 'meetingId'. 'meetingId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Meeting ID
|
meetingId | True | string |
The meeting identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update note
- Operation ID:
- UpdateNote
Performs a partial update of an object identified by 'noteId'. 'noteId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Note ID
|
noteId | True | string |
The note identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update postal mail
- Operation ID:
- Update56
Performs a partial update of an object identified by 'postalMailId'. 'postalMailId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Postal Mail ID
|
postalMailId | True | string |
The postal mail identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update task
- Operation ID:
- UpdateTask
Performs a partial update of an object identified by 'taskId'. 'taskId' refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Task ID
|
taskId | True | string |
The task identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Definitions
string
This is the basic data type 'string'.