Skip to content

Replace a signature layout

Request

Replaces the whole signature layout, image included: omitting image removes it. The same rules of the creation apply. The layout named default cannot be renamed.

Security
Bearer or PersonalAccessToken
Path
organizationIdstring, (uuid)required

Unique identifier of the organization

layoutIdstring, (uuid)required
Bodyapplication/jsonrequired
namestringrequired

The name: 1-50 letters, digits or hyphens, not starting or ending with a hyphen. Unique within the organization. "default" is reserved.

fieldsobject(SignatureLayoutFieldsRequest)required

The configuration of the fields shown in the signature appearance.

imageobject(SignatureLayoutImage)

The image of the signature appearance.

PUT
/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}
curl -i -X PUT \
  '/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "compact-layout",
    "fields": {
      "signerName": {
        "visible": true
      },
      "signerEmail": {
        "visible": true
      },
      "ipAddress": {
        "visible": false
      },
      "reason": {
        "visible": true
      },
      "dateTime": {
        "visible": true,
        "format": "dd/MM/yyyy | HH:mm",
        "localTimezone": false,
        "timezone": "Europe/Berlin"
      },
      "customText": {
        "visible": false
      }
    }
  }'

Responses

No Content

Response
No content