Function createMessageByCustomer

createMessageByCustomer<ThrowOnError extends boolean = true>(
    options: Options<CreateMessageByCustomerData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                app: string;
                channel: string;
                createdAt: string;
                direction: string;
                meta: { [key: string]: unknown };
                modifiedAt: string;
                sentAt: string;
                size: number;
                status: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                conversation: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                customer: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                modifiedBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Create message by customer ID Creates a new message based on the unique customer ID.

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

Legacy Role Equivalent Permission Set Role

org.user.message.write org.permission.message.create

Note

If a conversation is specified, the message will be linked to the existing conversation. Otherwise, a new conversation will be created and associated with the message.

Authorization
The org.admin role is required for setting createdAt, createdBy, modifiedAt, and modifiedBy. Otherwise, these attributes are automatically set by the token.

Rate Limit
Messages are subject to a rate limit. A single client can create up to 120 messages per minute per customer. Messages with importedAt in their body will not be subject to the rate limit.

A 429 Too Many Requests response will be returned if the rate limit has been reached for a customer.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<CreateMessageByCustomerData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                app: string;
                channel: string;
                createdAt: string;
                direction: string;
                meta: { [key: string]: unknown };
                modifiedAt: string;
                sentAt: string;
                size: number;
                status: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                conversation: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                customer: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                modifiedBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:2075

Function createMessageByCustomer

Note

Authorization

Rate Limit

Type Parameters

Parameters

Settings

On This Page