/messages/{id}

Returns a Message object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired

Token identifying the end user.

Query parameters

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstring or nullRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only

The datetime that this object was created by Merge.

modified_atdatetime or nullRead-only

The datetime that this object was modified by Merge.

user_idstring or nullformat: "uuid"

The user that sent the message.

conversation_idstring or nullformat: "uuid"

The conversation this message belongs to.

bodystring or null

The body of the message.

subject_linestring or null

The subject line of the message.

root_message_idstring or nullformat: "uuid"

The root message this message belongs to.

urlstring or nullformat: "uri"<=500 characters

The url of the message.

remote_created_atdatetime or null

When the third party's conversation was created.

remote_updated_atdatetime or null

When the third party's conversation was updated.

remote_was_deletedboolean or nullRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

user_idstring or nullOptionalformat: "uuid"

The user that sent the message.

conversation_idstring or nullOptionalformat: "uuid"

The conversation this message belongs to.

bodystring or nullOptional

The body of the message.

subject_linestring or nullOptional

The subject line of the message.

root_message_idstring or nullOptionalformat: "uuid"

The root message this message belongs to.

urlstring or nullOptionalformat: "uri"<=500 characters

The url of the message.

remote_created_atdatetime or nullOptional

When the third party's conversation was created.

remote_updated_atdatetime or nullOptional

When the third party's conversation was updated.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

user_idstring or nullOptionalformat: "uuid"

The user that sent the message.

conversation_idstring or nullOptionalformat: "uuid"

The conversation this message belongs to.

bodystring or nullOptional

The body of the message.

subject_linestring or nullOptional

The subject line of the message.

root_message_idstring or nullOptionalformat: "uuid"

The root message this message belongs to.

urlstring or nullOptionalformat: "uri"<=500 characters

The url of the message.

remote_created_atdatetime or nullOptional

When the third party's conversation was created.

remote_updated_atdatetime or nullOptional

When the third party's conversation was updated.

1	{
2	"id": "m1f2d8a4-9f7a-4e2b-8e2f-123456789abc",
3	"remote_id": "mem-001",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"user_id": "a1234567-89ab-cdef-0123-456789abcdef",
7	"conversation_id": "a1234567-89ab-cdef-0123-456789abcdef",
8	"body": "Hello World",
9	"subject_line": "Hello World",
10	"root_message_id": "a1234567-89ab-cdef-0123-456789abcdef",
11	"url": "https://example.com/messages/mem-001",
12	"remote_created_at": "2021-09-15T00:00:00Z",
13	"remote_updated_at": "2021-09-16T00:00:00Z",
14	"remote_was_deleted": true
15	}

/messages/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration

1	curl https://api.merge.dev/api/chat/v1/messages/id \
2	-H "X-Account-Token: X-Account-Token" \
3	-H "Authorization: Bearer <token>"