A ConversationParticipant object describes a single participant in a conversation who can send messages and receive replies.
Each Conversation must have one or more participants, which are described by ConversationParticipant objects.
A participant can be linked to an existing record - a Contact, Company or User - or just refer to a plain email address when there is no match for a corresponding record.
The ConversationParticipant Object
ConversationParticipant Object| Attribute | Data Type | Description |
|---|---|---|
| contact | Integer | Read Only. The ID of the contact record to which this participant refers to, if any. Null if either company or user are present. |
| company | Integer | Read Only. The ID of the company record to which this participant refers to, if any. Null if either contact or user are present. |
| user | Integer | Read Only. The ID of the user record to which this participant refers to, if any. Null if either contact or company are present. |
| name | String | Read Only. The name of the participant. Shows email if name is unknown. |
| String | Read Only. The email address of the participant, to which new messages in the conversation will be sent to. |
Example ConversationParticipant Object
ConversationParticipant Object{
"contact": 1234, // <- This participant has an associated contact record.
"company": null,
"user": null,
"name": "John Smith",
"email": "[email protected]"
}
