Function createNote

createNote<ThrowOnError extends boolean = true>(
    options: Options<CreateNoteData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: { body: string; createdAt: string; externalId: 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 Creates a note.

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

Legacy Role Equivalent Permission Set Role

org.user.note.write org.permission.note.create

Rate limit
Notes are subject to a rate limit. A single client can create up to 120 notes per minute per customer.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<CreateNoteData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: { body: string; createdAt: string; externalId: 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,
>
- Defined in src/api/sdk.gen.ts:3604

Function createNote

Rate limit

Type Parameters

Parameters

Settings

On This Page