Update email footer

[!WARNING] This endpoint is deprecated.

Allows users to update a specific email footer text of the organization.

put/v2/organizations/{org_id}/email-footers/{footer_id}

Request

Path parameters

ID of the organization the email footer is retrieved for.

ID of the retrieved footer.

Request body

activeboolean required

Set this footer active or not. Possible values: true - set active, false - deactivate.

footerstring required

The footer text.

Response

Returns the 204: No content in case of successful response for the admins and moderators with trial, professional and enterprise subscription. Returns an error when:

  • If user is not admin/moderator of the Org, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If user who does not have appropriate subscription tries to update settings, "code": 12003002. Message: "Access denied for current asubscription."
  • If user tries to update settings of the organization that is not active or does not exist, "code": 12003001. Message: "Organization deXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX is not found."
  • Email footer is not found, "code": 12010003. Message: "EmailFooter % is not found."
  • The footer field must be a string, "code": 12010001. Message: "The footer field must be a string."
  • The footer field length must be less than 65536 characters, "code": 12010005. Message: "The footer field length must be less than 65536 characters."
  • The active field must be a boolean value, "code": 12010006. Message: "The active field must be a boolean value."
object required

Changes

No recorded changes to this operation across all 1 revision of this API.