CRM Generic APIsCommunications

Create Communication

Create a communication for an integration.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
integration_idstringRequired
community_idstringOptional
The Propexo unique identifier for the community
prospect_idstringOptional
The Propexo unique identifier for the prospect
communication_typeenumOptional
Allowed values:
communication_directionenumOptional
The direction of the communication
Allowed values:
message_subjectstringOptional>=1 character
The subject of the message
message_bodystringOptional>=1 character
The body of the message
to_addresseslist of stringsOptional

The address(es) the communication will be sent to

from_addressstringOptional>=1 character
The address the communication will be sent from

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors