Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Get a Message by External ID

Retrieves a single message using its unique external message ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.message.read|org.permission.message.read|

| Key | Value | Description | |-|-|-| | externalID | string | Unique external ID of the message. |

Output

type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: externalId: type: string channel: type: string app: type: string size: type: string direction: type: string preview: type: string sentiment: type: object properties: confidence: type: string polarity: type: string meta: type: object properties: subject: type: string from: type: string to: type: array items: type: object properties: email: type: string cc: type: string recipient: type: object properties: email: type: string mailboxHash: type: string inReplyTo: type: string status: type: string sentAt: type: string createdAt: type: string updatedAt: type: string modifiedAt: type: string relationships: type: object properties: org: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string modifiedBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string customer: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string conversation: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string related: type: string