TextMessages.update - PipelinerCRM

Modifies TextMessage or TextMessages with given id(s)

Request

Path Params

string <uuid>

required

ID of TextMessage to update

Query Params

validation-level

integer <int32>

optional

Specify validation level of TextMessage 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

content

string

optional

String value.

Example:

string

datetime_sent

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

direction

enum<integer>

optional

Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail

Allowed values:

Example:

message_sid

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

status

enum<integer>

optional

Integer enum value: 1 - Sending, 2 - Sent, 3 - Failed, 4 - Received, 5 - Seen

Allowed values:

12345

Example:

text_message_conversation_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

attachments

array [object {1}]

optional

Relations to CloudObjects.

string <uri>

optional

Example

{
    "content": "string",
    "datetime_sent": "2019-01-01T00:00:00",
    "direction": 1,
    "message_sid": "string",
    "status": 1,
    "text_message_conversation_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "attachments": [
        {
            "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 TextMessage

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (TextMessage)

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

text_message_conversation

string <uri>

required

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

content

string

required

String value.

Example:

string

datetime_sent

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

direction

enum<integer>

required

Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail

Allowed values:

Example:

message_sid

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

status

enum<integer>

optional

Integer enum value: 1 - Sending, 2 - Sent, 3 - Failed, 4 - Received, 5 - Seen

Allowed values:

12345

Example:

text_message_conversation_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

attachments

array[string <uri>]

optional

Relations to CloudObjects.

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",
        "text_message_conversation": "http://example.com",
        "content": "string",
        "datetime_sent": "2019-01-01T00:00:00",
        "direction": 1,
        "message_sid": "string",
        "status": 1,
        "text_message_conversation_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1,
        "attachments": [
            "http://example.com"
        ]
    }
}

🟠404Record Not Found

🔴500Server Error