draft_content. For a campaign, you send it as content.
The full schema is documented as
signature_content on the Create a signature (POST /v1/signatures) request in the endpoint reference. This page explains how the tree is shaped so your writes pass validation.The shape of the tree
The tree always starts with a singlestack block at the root. Every block has a type, and a stack holds an ordered list of child blocks in its children array. A child can itself be a stack, which is how rows, columns, and groups are built.
Block types
The
list and socialList blocks contain their own item blocks (listItem, listItemLabel, and socialListItem).
Smart-field tokens
Text and other blocks can include smart-field tokens that resolve to a teammate’s data, such as their name, job title, or phone number, when the signature renders. This is how one template produces a personalized signature for every teammate. Define the available fields with the smart fields endpoints (GET /v1/smart_fields and POST /v1/smart_fields).
Write content safely
Validation is strict. An invalid tree is rejected with422, and the response pinpoints the offending field. The safest way to produce a valid tree is to start from one that already renders:
1
Read an existing signature
Fetch a signature whose layout is close to what you want with
GET /v1/signatures, and copy its content.2
Modify the tree
Change only what you need, for example swapping an image URL or editing the text of a block, and keep the structure intact.
3
Write it back
Send the updated tree as
draft_content on POST /v1/signatures or PATCH /v1/signatures/{id}.Publish your changes
Writingdraft_content updates the draft only. To make a signature live, call POST /v1/signatures/{id}/publish. Publishing copies the draft into the published content and triggers installation for the assigned recipients. To re-trigger installation without changing the content, call POST /v1/signatures/{id}/install.
Related
- Signatures overview: how signatures work in Scribe.
- Smart fields: personalize signatures with dynamic data.
- Campaigns overview: run promotional banners across your team’s signatures.