Function createForwardByConversation

createForwardByConversation<ThrowOnError extends boolean = true>(
    options: Options<CreateForwardByConversationData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                app: string;
                channel: string;
                createdAt: string;
                from: { email: string; name: string };
                modifiedAt: string;
                status: string;
                to: { email: string; name: string }[];
                updatedAt: string;
            };
            id: string;
            relationships: {
                attachments?: {
                    data: { id: string; type: string };
                    links: { self: string };
                }[];
                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 forward by conversation Creates a forward to send through email. Forwards will send all messages in a conversation.

NOTE

To schedule the forward for delivery, create a forward with a sendAt property.

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

Legacy Role Equivalent Permission Set Role

org.user.conversation_forward.write org.permission.conversation_forward.create
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<CreateForwardByConversationData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                app: string;
                channel: string;
                createdAt: string;
                from: { email: string; name: string };
                modifiedAt: string;
                status: string;
                to: { email: string; name: string }[];
                updatedAt: string;
            };
            id: string;
            relationships: {
                attachments?: {
                    data: { id: string; type: string };
                    links: { self: string };
                }[];
                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:1441

Function createForwardByConversation

NOTE

Type Parameters

Parameters

Settings

On This Page