Skip to main content
PUT
Update EmailTemplateFile
Updates an existing EmailTemplateFile record. You must include the Id of the record to update along with all required fields.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the EmailTemplateFile-Edit role.

Enums

Request Body

Required Fields

integer
required
The Id of the EmailTemplateFile record to update.
integer
required
ID of the business linked to this record.
integer
required
The language value for this email template file.
string
required
The name value for this email template file.
string
required
The subject value for this email template file.

Optional Fields

integer
ID of the file language linked to this record.
string
The file contents value for this email template file.
boolean
Whether is text only is enabled.
string
The from name value for this email template file.
string
The from email value for this email template file.
string
The cc email value for this email template file.
string
The cco email value for this email template file.

Code Examples

Response

200

integer
HTTP status code. 200 on success.
string
A human-readable message confirming the update.
object
Contains the Id of the updated record.
boolean
true if the emailtemplatefile was updated successfully.
array
null on success.
Example Response

400

string
A summary of the validation error(s), in the format PropertyName: error message.
any
null on validation failure.
object[]
Array of validation errors.
boolean
false when the request fails validation.
Example Response