Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Create Note

Create a note with this action.

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|

Input

type: object properties: data: type: string example: >- "\"{\\n \\\"body\\\": \\\"<string>\\\",\\n \\\"id\\\": \\\"<object-id>\\\",\\n \\\"externalId\\\": \\\"<string>\\\",\\n \\\"userMentions\\\": [\\n {\\n \\\"user\\\": \\\"<string>\\\",\\n \\\"team\\\": \\\"<string>\\\"\\n },\\n {\\n \\\"user\\\": \\\"<string>\\\",\\n \\\"team\\\": \\\"<string>\\\"\\n }\\n ],\\n \\\"createdAt\\\": \\\"<dateTime>\\\",\\n \\\"modifiedAt\\\": \\\"<dateTime>\\\",\\n \\\"createdBy\\\": \\\"<object-id>\\\",\\n \\\"modifiedBy\\\": \\\"<object-id>\\\"\\n}\"" title: Data

Output

type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: body: type: string externalId: type: string createdAt: type: string updatedAt: type: string modifiedAt: type: string deleted: type: string deletedAt: 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 modifiedBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string deletedBy: 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