Function createNoteWithinConversation

createNoteWithinConversation<ThrowOnError extends boolean = true>(
    options: Options<CreateNoteWithinConversationData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: { body: string; createdAt: 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 };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
                userMentions: { data: { id: string; type: string }[] };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Create note within conversation Creates a new note within a conversation. Optionally, allows you to
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<CreateNoteWithinConversationData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: { body: string; createdAt: 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 };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
                userMentions: { data: { id: string; type: string }[] };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Mention
another user in your Kustomer organization.

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

Legacy Role Equivalent Permission Set Role

org.user.note.read org.permission.note.create

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
Notes are subject to a rate limit. A single client can create up to 120 notes per minute per customer.
- Defined in src/api/sdk.gen.ts:1549

Function createNoteWithinConversation

Type Parameters

Parameters

Mention

Authorization

Rate limit

Settings

On This Page