v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Text

TextMessageConversations.update

Modifies TextMessageConversation or TextMessageConversations with given id(s)

patch/entities/TextMessageConversations/{id}

Path parameters

idstring uuid required

ID of TextMessageConversation to update

Query parameters

validation-levelinteger

Specify validation level of TextMessageConversation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

phone_idstring uuid

Id of the sender phone.

recipient_account_idstring uuid

Id of the matched account.

recipient_contact_idstring uuid

Id of the matched contact.

recipient_phone_numberstring

External phone number of the conversation recipient. Cannot be changed once the conversation has started.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "phone_id": "01234567-abcd-dcba-ffff-000000000000",
  "recipient_account_id": "01234567-abcd-dcba-ffff-000000000000",
  "recipient_contact_id": "01234567-abcd-dcba-ffff-000000000000",
  "recipient_phone_number": "string",
  "revision": 1
}

Response

Modification confirmation. Returns resulting TextMessageConversation

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "phone_id": "01234567-abcd-dcba-ffff-000000000000",
    "recipient_account_id": "01234567-abcd-dcba-ffff-000000000000",
    "recipient_contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "recipient_phone_number": "string",
    "revision": 1
  }
}