Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Update Note by ID (patch)

Update one or more note attibutes.

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", meaning that a single user is limited in how many updates they can make to a single Note. Please see the API Rate Limiting section of the documentation for additional details.

Authorization

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

Input

type: object properties: parameters: type: object properties: id: type: string description: (Required) Unique ID of the note. required: - id title: Parameters data: type: string example: >- "{\n \"conversation\": \"<string>\",\n \"externalId\": \"<string>\",\n \"body\": \"<string>\",\n \"userMentions\": [\n {\n \"user\": \"<string>\",\n \"team\": \"<string>\"\n },\n {\n \"user\": \"<string>\",\n \"team\": \"<string>\"\n }\n ],\n \"deleted\": \"<boolean>\",\n \"attachments\": [\n {\n \"_id\": \"<object-id>\",\n \"name\": \"<string>\",\n \"contentType\": \"<string>\",\n \"contentLength\": \"<number>\",\n \"sourceId\": \"<object-id>\"\n }\n ],\n \"createdAt\": \"<dateTime>\",\n \"modifiedAt\": \"<dateTime>\",\n \"updatedAt\": \"<dateTime>\",\n \"createdBy\": \"<object-id>\",\n \"modifiedBy\": \"<object-id>\",\n \"lang\": \"<string>\"\n}" title: Data

Output

type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: body: type: string createdAt: type: string updatedAt: type: string relationships: type: object properties: org: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string customer: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string createdBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string conversation: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string userMentions: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string