ConversationParticipant

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

AttributeData TypeDescription
contactIntegerRead Only. The ID of the contact record to which this participant refers to, if any. Null if either company or user are present.
companyIntegerRead Only. The ID of the company record to which this participant refers to, if any. Null if either contact or user are present.
userIntegerRead Only. The ID of the user record to which this participant refers to, if any. Null if either contact or company are present.
nameStringRead Only. The name of the participant. Shows email if name is unknown.
emailStringRead Only. The email address of the participant, to which new messages in the conversation will be sent to.

Example ConversationParticipant Object

{
  "contact": 1234, // <- This participant has an associated contact record.
  "company": null, 
  "user": null,
  "name": "John Smith",
  "email": "[email protected]"
}