communicationTemplate.addAttachment

Adds an uploaded file to a reusable email template you can edit. Create a file upload handle with fileUploadContext: "CommunicationTemplateAttachment", then POST the file to the returned URL as multipart/form-data, including all returned fields before the file field. Files may be up to 15 MiB each. Pass the upload handle here using the same API user or on-behalf-of user. Document Library selection is not supported.

Returns the updated template, with attachmentId identifying the attachment added by this request. Downloading a file through file.info requires communicationTemplates:read. The upload URL expires after 10 minutes. Upload and attach the file promptly.

After a timeout or server error, reread the template's attachments before retrying: the attachment may already be saved. Upload handles do not prevent duplicates. Use communicationTemplate.removeAttachment to remove an extra attachment. If the uploaded file is no longer available, upload it again.

Requires the communicationTemplatesWrite permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The reusable email template’s ID.

attachment
object
required
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json