Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Create attachment

Creates a new attachment document. Includes a temporary upload policy for uploading the file via POST request.

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| |org.user.message.write|org.permission.message.create|

Uploading Attachments

Uploads are conducted by sending a multipart POST request to the URL found in the response object's meta.upload.url property. The request must be accompanied by the key/value pairs found in meta.upload.fields as standard form keys. The file should be included as the last key under the name "file".

Input

type: object properties: data: type: string example: >- "{\n \"name\": \"<string>\",\n \"contentType\": \"<string>\",\n \"contentLength\": \"<number>\"\n}" title: Data

Output

type: object properties: data: type: object properties: id: type: string type: type: string attributes: type: object properties: name: type: string contentType: type: string contentLength: type: string uploaded: type: string redacted: type: string relationships: type: object properties: org: type: object properties: data: type: object properties: id: type: string type: type: string links: type: object properties: self: type: string links: type: object properties: self: type: string related: type: string meta: type: object properties: upload: type: object properties: url: type: string fields: type: object properties: key: type: string acl: type: string Content-Type: type: string X-Amz-Meta-Attachment-Id: type: string bucket: type: string X-Amz-Algorithm: type: string X-Amz-Credential: type: string X-Amz-Date: type: string Policy: type: string X-Amz-Signature: type: string