Skip to content

Message participants

Open .md

API reference Messages and activity

One person on an order's or purchase order's message thread, by participant id: who receives its customer emails and texts. To list or add an order's participants, use Sales order messages.

4 operations

  • GETGet a message participant/v1/api/store/{team_slug}/participant/{id}Returns one person on an order's or purchase order's message thread: who they are (type), how to reach them, and what they receive (status, can_receive_mail, can_receive_sms).
  • PUTChange a message participant/v1/api/store/{team_slug}/participant/{id}Changes what a participant receives on an order's or purchase order's message thread.
  • PATCHChange a message participant without checks/v1/api/store/{team_slug}/participant/{id}Use PUT to change a message participant.
  • DELETERemove a message participant/v1/api/store/{team_slug}/participant/{id}Removes a person from an order's or purchase order's message thread, so they stop getting its emails and texts.