SMSviewset

get

API endpoint that allows users to be viewed or edited.

Authorizations

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/common/messenger/sms/

GET /ux/common/messenger/sms/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "event_time": "text",
    "communication_id": "text",
    "msg_type": 1,
    "type": "text",
    "user_id": "text",
    "received_config_id": "text",
    "module_id": 1,
    "ref_id": "text",
    "ref_display_id": "text",
    "is_system_gen": true,
    "imap_config_id": "text",
    "attachment_ids": [],
    "created_by": "text",
    "organization": "text",
    "creation_time": "2026-01-22T13:51:34.325Z",
    "last_update_time": "2026-01-22T13:51:34.325Z",
    "is_deleted": true,
    "is_assignee_read": true,
    "message_read_map": [
      {
        "keys": "text",
        "values": "text",
        "queryparam": true
      }
    ],
    "customer_id": "text",
    "customer_entity_id": "text",
    "is_description": true,
    "email_data": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    },
    "sms_data": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    },
    "api_data": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    },
    "beep_data": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  }
]

post

API endpoint that allows users to be viewed or edited.

Authorizations

AuthorizationstringRequired

Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

event_timestringRead-onlyRequired

communication_idstringOptional

msg_typeintegerOptional

typestringOptional

user_idstringOptional

received_config_idstringOptional

module_idintegerOptional

ref_idstringOptional

ref_display_idstringOptional

is_system_genbooleanOptional

imap_config_idstringOptional

created_bystringOptional

organizationstringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_deletedbooleanOptional

is_assignee_readbooleanOptional

customer_idstringOptional

customer_entity_idstringOptional

is_descriptionbooleanOptional

Responses

201Success

application/json

post

/ux/common/messenger/sms/

POST /ux/common/messenger/sms/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 780

{
  "communication_id": "text",
  "msg_type": 1,
  "type": "text",
  "user_id": "text",
  "received_config_id": "text",
  "module_id": 1,
  "ref_id": "text",
  "ref_display_id": "text",
  "is_system_gen": true,
  "imap_config_id": "text",
  "attachment_ids": [],
  "created_by": "text",
  "organization": "text",
  "creation_time": "2026-01-22T13:51:34.325Z",
  "last_update_time": "2026-01-22T13:51:34.325Z",
  "is_deleted": true,
  "is_assignee_read": true,
  "message_read_map": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "customer_id": "text",
  "customer_entity_id": "text",
  "is_description": true,
  "email_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "sms_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "api_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "beep_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

201Success

{
  "id": "text",
  "event_time": "text",
  "communication_id": "text",
  "msg_type": 1,
  "type": "text",
  "user_id": "text",
  "received_config_id": "text",
  "module_id": 1,
  "ref_id": "text",
  "ref_display_id": "text",
  "is_system_gen": true,
  "imap_config_id": "text",
  "attachment_ids": [],
  "created_by": "text",
  "organization": "text",
  "creation_time": "2026-01-22T13:51:34.325Z",
  "last_update_time": "2026-01-22T13:51:34.325Z",
  "is_deleted": true,
  "is_assignee_read": true,
  "message_read_map": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "customer_id": "text",
  "customer_entity_id": "text",
  "is_description": true,
  "email_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "sms_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "api_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "beep_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

200Success

application/json

get

/ux/common/messenger/sms/{id}/

GET /ux/common/messenger/sms/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "event_time": "text",
  "communication_id": "text",
  "msg_type": 1,
  "type": "text",
  "user_id": "text",
  "received_config_id": "text",
  "module_id": 1,
  "ref_id": "text",
  "ref_display_id": "text",
  "is_system_gen": true,
  "imap_config_id": "text",
  "attachment_ids": [],
  "created_by": "text",
  "organization": "text",
  "creation_time": "2026-01-22T13:51:34.325Z",
  "last_update_time": "2026-01-22T13:51:34.325Z",
  "is_deleted": true,
  "is_assignee_read": true,
  "message_read_map": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "customer_id": "text",
  "customer_entity_id": "text",
  "is_description": true,
  "email_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "sms_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "api_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "beep_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

put

API endpoint that allows users to be viewed or edited.

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

event_timestringRead-onlyRequired

communication_idstringOptional

msg_typeintegerOptional

typestringOptional

user_idstringOptional

received_config_idstringOptional

module_idintegerOptional

ref_idstringOptional

ref_display_idstringOptional

is_system_genbooleanOptional

imap_config_idstringOptional

created_bystringOptional

organizationstringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_deletedbooleanOptional

is_assignee_readbooleanOptional

customer_idstringOptional

customer_entity_idstringOptional

is_descriptionbooleanOptional

Responses

200Success

application/json

put

/ux/common/messenger/sms/{id}/

PUT /ux/common/messenger/sms/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 780

{
  "communication_id": "text",
  "msg_type": 1,
  "type": "text",
  "user_id": "text",
  "received_config_id": "text",
  "module_id": 1,
  "ref_id": "text",
  "ref_display_id": "text",
  "is_system_gen": true,
  "imap_config_id": "text",
  "attachment_ids": [],
  "created_by": "text",
  "organization": "text",
  "creation_time": "2026-01-22T13:51:34.325Z",
  "last_update_time": "2026-01-22T13:51:34.325Z",
  "is_deleted": true,
  "is_assignee_read": true,
  "message_read_map": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "customer_id": "text",
  "customer_entity_id": "text",
  "is_description": true,
  "email_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "sms_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "api_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "beep_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

200Success

{
  "id": "text",
  "event_time": "text",
  "communication_id": "text",
  "msg_type": 1,
  "type": "text",
  "user_id": "text",
  "received_config_id": "text",
  "module_id": 1,
  "ref_id": "text",
  "ref_display_id": "text",
  "is_system_gen": true,
  "imap_config_id": "text",
  "attachment_ids": [],
  "created_by": "text",
  "organization": "text",
  "creation_time": "2026-01-22T13:51:34.325Z",
  "last_update_time": "2026-01-22T13:51:34.325Z",
  "is_deleted": true,
  "is_assignee_read": true,
  "message_read_map": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "customer_id": "text",
  "customer_entity_id": "text",
  "is_description": true,
  "email_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "sms_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "api_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "beep_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

delete

API endpoint that allows users to be viewed or edited.

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

204

No response body

delete

/ux/common/messenger/sms/{id}/

DELETE /ux/common/messenger/sms/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

patch

API endpoint that allows users to be viewed or edited.

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyOptional

event_timestringRead-onlyOptional

communication_idstringOptional

msg_typeintegerOptional

typestringOptional

user_idstringOptional

received_config_idstringOptional

module_idintegerOptional

ref_idstringOptional

ref_display_idstringOptional

is_system_genbooleanOptional

imap_config_idstringOptional

created_bystringOptional

organizationstringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_deletedbooleanOptional

is_assignee_readbooleanOptional

customer_idstringOptional

customer_entity_idstringOptional

is_descriptionbooleanOptional

Responses

200Success

application/json

patch

/ux/common/messenger/sms/{id}/

PATCH /ux/common/messenger/sms/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 780

{
  "communication_id": "text",
  "msg_type": 1,
  "type": "text",
  "user_id": "text",
  "received_config_id": "text",
  "module_id": 1,
  "ref_id": "text",
  "ref_display_id": "text",
  "is_system_gen": true,
  "imap_config_id": "text",
  "attachment_ids": [],
  "created_by": "text",
  "organization": "text",
  "creation_time": "2026-01-22T13:51:34.325Z",
  "last_update_time": "2026-01-22T13:51:34.325Z",
  "is_deleted": true,
  "is_assignee_read": true,
  "message_read_map": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "customer_id": "text",
  "customer_entity_id": "text",
  "is_description": true,
  "email_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "sms_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "api_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "beep_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

200Success

{
  "id": "text",
  "event_time": "text",
  "communication_id": "text",
  "msg_type": 1,
  "type": "text",
  "user_id": "text",
  "received_config_id": "text",
  "module_id": 1,
  "ref_id": "text",
  "ref_display_id": "text",
  "is_system_gen": true,
  "imap_config_id": "text",
  "attachment_ids": [],
  "created_by": "text",
  "organization": "text",
  "creation_time": "2026-01-22T13:51:34.325Z",
  "last_update_time": "2026-01-22T13:51:34.325Z",
  "is_deleted": true,
  "is_assignee_read": true,
  "message_read_map": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "customer_id": "text",
  "customer_entity_id": "text",
  "is_description": true,
  "email_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "sms_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "api_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "beep_data": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

PreviousBeepViewSet NextSuppressedviewset

Last updated 9 months ago