Optional
requestFactory: BatchApiRequestFactoryOptional
responseProcessor: BatchApiResponseProcessorOptional
_options: PromiseConfigurationOptionsDelete a batch of messages by ID. A deleted message can be restored within 90 days of being deleted. Learn more about restoring activity records. Archive a batch of communications by ID
Optional
_options: PromiseConfigurationOptionsCreate a batch of messages. The inputs
array can contain a properties
object to define property values for each message, along with an associations
array to define associations with other CRM records.
Create a batch of communications
Optional
_options: PromiseConfigurationOptionsCreate a batch of messages. The inputs
array can contain a properties
object to define property values for each message, along with an associations
array to define associations with other CRM records.
Create a batch of communications
Optional
_options: PromiseConfigurationOptionsRetrieve a batch of messages by ID (communicationId
) or unique property value (idProperty
).
Read a batch of communications by internal ID, or unique property values
Optional
archived: booleanWhether to return only results that have been archived.
Optional
_options: PromiseConfigurationOptionsRetrieve a batch of messages by ID (communicationId
) or unique property value (idProperty
).
Read a batch of communications by internal ID, or unique property values
Optional
archived: booleanWhether to return only results that have been archived.
Optional
_options: PromiseConfigurationOptionsUpdate a batch of messages by ID (communicationId
) or unique property value (idProperty
). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Update a batch of communications by internal ID, or unique property values
Optional
_options: PromiseConfigurationOptionsUpdate a batch of messages by ID (communicationId
) or unique property value (idProperty
). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Update a batch of communications by internal ID, or unique property values
Optional
_options: PromiseConfigurationOptionsCreate or update records identified by a unique property value as specified by the idProperty
query param. idProperty
query param refers to a property whose values are unique for the object.
Create or update a batch of communications by unique property values
Optional
_options: PromiseConfigurationOptionsCreate or update records identified by a unique property value as specified by the idProperty
query param. idProperty
query param refers to a property whose values are unique for the object.
Create or update a batch of communications by unique property values
Optional
_options: PromiseConfigurationOptions
Delete a batch of messages by ID. A deleted message can be restored within 90 days of being deleted. Learn more about restoring activity records. Archive a batch of communications by ID