Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Signatures

Update signature

Update signature

Required scope: signatures:write

patch/signatures/{signature_id}

Path parameters

signature_idstring required

The signature ID

Request body

namestring

Name of the signature

sender_infostring

Sender info of the signature that will appear in the From line of emails sent.

bodystring

Body of the signature

is_visible_for_all_teammate_channelsboolean

Whether or not the signature is visible in all individual channels for teammates in the given team. Can only be set for shared signatures.

is_defaultboolean

If true, the signature will be set as the default signature for the team or teammate.

channel_idsstring[]

The specific shared channels this signature if available in. If null, then it will be available in all channels. If unspecified, will retain previous value. Alternatively, you can specify channels using a resource alias.

Response

A signature

idstring required

Unique identifier of the signature

namestring nullable required

Name of the signature

bodystring required

Body of the signature

sender_infostring nullable required

Sender info of the signature

is_visible_for_all_teammate_channelsboolean required

Whether or not the signature is available in teammate channels.

is_defaultboolean required

Whether the signature is the default signature for the team or teammate.

is_privateboolean required

Whether the signature is private to the teammate.

channel_idsstring[] nullable required

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/signatures/sig_6rrv2",
    "related": {
      "owner": "https://yourCompany.api.frontapp.com/teams/tim_k30"
    }
  },
  "id": "sig_6rrv2",
  "name": "Finer Things Club signature",
  "body": "<div>—<br />{{user.name}}<br />No paper, no plastic, and no work talk allowed<br /></div>",
  "is_visible_for_all_teammate_channels": true,
  "is_private": true
}