Function updateNoteById

updateNoteById<ThrowOnError extends boolean = true>(
    options: Options<UpdateNoteByIdData, 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,
>
Update note by ID Updates a note based on the unique note ID.

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

Legacy Role Equivalent Permission Set Role

org.user.note.write org.permission.note.update

Note

This endpoint is subject to Object Rate Limiting, which limits how many updates single user can make to a single note. To learn more, see Rate limiting.

Authorization

The org.admin role is required for setting createdAt, createdBy, modifiedAt, and modifiedBy. Otherwise, these attributes are automatically set by the token.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<UpdateNoteByIdData, 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,
>
- Defined in src/api/sdk.gen.ts:3700

Function updateNoteById

Note

Authorization

Type Parameters

Parameters

Settings

On This Page