TextMessageConversations.update

Modifies TextMessageConversation or TextMessageConversations with given id(s)

Request

Path Params

string <uuid>

required

ID of TextMessageConversation to update

Query Params

validation-level

integer <int32>

optional

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.

Body Params application/json

phone_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

recipient_account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

recipient_contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

recipient_phone_number

string

optional

Phone number.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

messages

array [object {1}]

optional

Relations to TextMessages.

string <uri>

optional

account_relations

array [object {1}]

optional

Relations to Accounts.

string <uri>

optional

contact_relations

array [object {1}]

optional

Relations to Contacts.

string <uri>

optional

project_relations

array [object {1}]

optional

Relations to Projects.

string <uri>

optional

lead_relations

array [object {1}]

optional

Relations to Leads.

string <uri>

optional

opportunity_relations

array [object {1}]

optional

Relations to Opportunitys.

string <uri>

optional

quote_relations

array [object {1}]

optional

Relations to Quotes.

string <uri>

optional

Example

{
    "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,
    "messages": [
        {
            "id": "http://example.com"
        }
    ],
    "account_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "contact_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "project_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "lead_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "opportunity_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "quote_relations": [
        {
            "id": "http://example.com"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting TextMessageConversation

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (TextMessageConversation)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

phone

string <uri>

required

Relation to Phone. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Phone' object for properties.

recipient_account

string <uri>

optional

Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties.

recipient_contact

string <uri>

optional

Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties.

phone_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

recipient_account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

recipient_contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

recipient_phone_number

string

optional

Phone number.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

messages

array[string <uri>]

optional

Relations to TextMessages.

account_relations

array[string <uri>]

optional

Relations to Accounts.

contact_relations

array[string <uri>]

optional

Relations to Contacts.

project_relations

array[string <uri>]

optional

Relations to Projects.

lead_relations

array[string <uri>]

optional

Relations to Leads.

opportunity_relations

array[string <uri>]

optional

Relations to Opportunitys.

quote_relations

array[string <uri>]

optional

Relations to Quotes.

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "phone": "http://example.com",
        "recipient_account": "http://example.com",
        "recipient_contact": "http://example.com",
        "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,
        "messages": [
            "http://example.com"
        ],
        "account_relations": [
            "http://example.com"
        ],
        "contact_relations": [
            "http://example.com"
        ],
        "project_relations": [
            "http://example.com"
        ],
        "lead_relations": [
            "http://example.com"
        ],
        "opportunity_relations": [
            "http://example.com"
        ],
        "quote_relations": [
            "http://example.com"
        ]
    }
}

🟠404Record Not Found

🔴500Server Error