8 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.
Create signature
email_signatures.createwrite
Create an email signature and render it. Nothing is sent — but the FIRST signature in a scope automatically becomes that scope's default, so an account signature created here starts appending to outbound email from the next send. Image URLs (logo, portrait, banner) must be publicly reachable: mail clients fetch them directly and a login-protected URL shows as a broken image in every inbox.
Parameters
Field
Type
Required
Description
name
string
required
Internal name for the signature. Only teammates see it.
scope
"personal" | "workspace"
optional
personal = only this caller's own signature. account = shared by everyone in the org and used as its fallback; requires an owner/admin. API keys act as owner. Default: "personal"
Layout. showcase = bordered card with a social rail down the left edge and the portrait framed right; aurora = portrait left with an accent rule; card = bordered business-card style; sidebar = portrait on a filled accent panel; stack = logo above a details column; compact = two dense lines; minimal = text only, no images. Default: "aurora"
is_default
boolean
optional
Make this the default in its scope, demoting whichever signature currently holds that role. Default: false
enabled
boolean
optional
false keeps the design but stops it being appended. Default: true
email_identity_id
string (uuid) (or null)
optional
Pin the signature to one account sending address, so anything sent from that address uses it whoever wrote the message. Outranks both defaults. Only one signature may be pinned to an address.
full_name
string
optional
Name shown at the top of the signature, e.g. Jordan Reyes.
job_title
string
optional
Role line under the name, e.g. Head of Partnerships.
company
string
optional
Company name, shown in the accent colour.
department
string
optional
Team or department, shown beside the job title.
email
string
optional
Contact email address. Rendered as a mailto: link.
phone
string
optional
Office phone, in whatever format you want displayed.
mobile
string
optional
Mobile phone, in whatever format you want displayed.
website
string
optional
Website. A bare host like acme.com is turned into https://acme.com.
address
string
optional
Postal address, on one line.
disclaimer
string
optional
Small print under the signature — confidentiality notices, registration numbers.
cta_label
string
optional
Text on the call-to-action button. Needs cta_url to render.
cta_url
string
optional
Where the call-to-action button goes. Needs cta_label to render.
banner_image_url
string
optional
Public URL of a wide banner image shown under the signature.
banner_url
string
optional
Where clicking the banner goes.
logo_url
string
optional
Public URL of the company logo. Must be reachable without a login — mail clients fetch it directly.
photo_url
string
optional
Public URL of the portrait actually shown. This is the animated GIF when the designer made one; set it directly only if you are hosting your own image.
photo_source_url
string
optional
Public URL of the original un-animated photo, kept so the designer can re-render the animation later.
photo_shape
"circle" | "rounded" | "square" | "shards"
optional
Frame around the portrait. 'shards' cuts the photo into offset diagonal blades with gaps between them — baked into the image, so it needs the designer to regenerate the portrait rather than just setting this field.
Which movement the portrait was built with. Descriptive only on this path — the moving image itself is produced in the designer and referenced by photo_url; setting this alone does not animate anything.
verified
boolean
optional
Show a blue verified check beside the name. Decorative only — nothing is verified.
accent_color
string
optional
Brand colour as #rrggbb. Used for the company line, links, rules and the CTA button.
text_color
string
optional
Body text colour as #rrggbb.
socials
object[]
optional
Social links, rendered as a row of small icons. Replaces the whole list when supplied.
socials[].network
"linkedin" | "x" | "facebook" | "instagram" | "youtube" | "tiktok" | … 4 more
Over MCP the same operation is the tool email_signatures_create at https://app.chirply.io/api/mcp, same bearer token, same input.
Delete signature
email_signatures.deletewriteconfirm
Permanently delete a signature. This cannot be undone. Email already sent keeps the signature it went out with; new email stops using this one, and if it was a default the oldest remaining signature in that scope takes over.
Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.
Over MCP the same operation is the tool email_signatures_list at https://app.chirply.io/api/mcp, same bearer token, same input.
Preview a signature
email_signatures.previewread
Render signature HTML and plain text from a set of fields WITHOUT saving anything. Use it to check a layout before creating a signature, or to produce markup to paste into Gmail, Outlook or Apple Mail. Changes nothing and sends nothing.
Layout. showcase = bordered card with a social rail down the left edge and the portrait framed right; aurora = portrait left with an accent rule; card = bordered business-card style; sidebar = portrait on a filled accent panel; stack = logo above a details column; compact = two dense lines; minimal = text only, no images. Default: "aurora"
full_name
string
optional
Name shown at the top of the signature, e.g. Jordan Reyes.
job_title
string
optional
Role line under the name, e.g. Head of Partnerships.
company
string
optional
Company name, shown in the accent colour.
department
string
optional
Team or department, shown beside the job title.
email
string
optional
Contact email address. Rendered as a mailto: link.
phone
string
optional
Office phone, in whatever format you want displayed.
mobile
string
optional
Mobile phone, in whatever format you want displayed.
website
string
optional
Website. A bare host like acme.com is turned into https://acme.com.
address
string
optional
Postal address, on one line.
disclaimer
string
optional
Small print under the signature — confidentiality notices, registration numbers.
cta_label
string
optional
Text on the call-to-action button. Needs cta_url to render.
cta_url
string
optional
Where the call-to-action button goes. Needs cta_label to render.
banner_image_url
string
optional
Public URL of a wide banner image shown under the signature.
banner_url
string
optional
Where clicking the banner goes.
logo_url
string
optional
Public URL of the company logo. Must be reachable without a login — mail clients fetch it directly.
photo_url
string
optional
Public URL of the portrait actually shown. This is the animated GIF when the designer made one; set it directly only if you are hosting your own image.
photo_source_url
string
optional
Public URL of the original un-animated photo, kept so the designer can re-render the animation later.
photo_shape
"circle" | "rounded" | "square" | "shards"
optional
Frame around the portrait. 'shards' cuts the photo into offset diagonal blades with gaps between them — baked into the image, so it needs the designer to regenerate the portrait rather than just setting this field.
Which movement the portrait was built with. Descriptive only on this path — the moving image itself is produced in the designer and referenced by photo_url; setting this alone does not animate anything.
verified
boolean
optional
Show a blue verified check beside the name. Decorative only — nothing is verified.
accent_color
string
optional
Brand colour as #rrggbb. Used for the company line, links, rules and the CTA button.
text_color
string
optional
Body text colour as #rrggbb.
socials
object[]
optional
Social links, rendered as a row of small icons. Replaces the whole list when supplied.
socials[].network
"linkedin" | "x" | "facebook" | "instagram" | "youtube" | "tiktok" | … 4 more
Over MCP the same operation is the tool email_signatures_preview at https://app.chirply.io/api/mcp, same bearer token, same input.
Sign my email automatically
email_signatures.set_auto_appendwrite
Turn automatic signature signing on or off for the CALLING USER — the same switch as “Sign my email automatically” in the signature designer. On, their signature is appended to one-to-one email they send from the inbox; off, their email goes out unsigned unless a message opts in. Affects only this user's own future sends and changes what those recipients see; it sends nothing itself, and other teammates' settings and the signatures themselves are untouched.
Parameters
Field
Type
Required
Description
enabled
boolean
required
true appends the caller's signature to the email they send; false stops appending it.
Over MCP the same operation is the tool email_signatures_set_auto_append at https://app.chirply.io/api/mcp, same bearer token, same input.
Make default
email_signatures.set_defaultwrite
Make one signature the default within its own scope, demoting the current default there. An account default is what signs email from anyone who has not made their own, so this changes what recipients see on the next send.
Over MCP the same operation is the tool email_signatures_set_default at https://app.chirply.io/api/mcp, same bearer token, same input.
Save changes
email_signatures.updatewrite
Update an existing signature and re-render it. Omitted fields are left alone, except socials, which replaces the whole list when supplied. Sends nothing — but this signature is appended to email from the next send onwards, so a change here changes what recipients see.
Parameters
Field
Type
Required
Description
id
string (uuid)
required
The signature to edit.
name
string
optional
Internal name for the signature. Only teammates see it.
scope
"personal" | "workspace"
optional
Move the signature between personal and account ownership.
Layout. showcase = bordered card with a social rail down the left edge and the portrait framed right; aurora = portrait left with an accent rule; card = bordered business-card style; sidebar = portrait on a filled accent panel; stack = logo above a details column; compact = two dense lines; minimal = text only, no images.
is_default
boolean
optional
Make this the default in its scope, demoting whichever signature currently holds that role.
enabled
boolean
optional
false keeps the design but stops it being appended.
email_identity_id
string (uuid) (or null)
optional
Pin to one sending address, or null to unpin. Only one signature may be pinned to an address.
full_name
string
optional
Name shown at the top of the signature, e.g. Jordan Reyes.
job_title
string
optional
Role line under the name, e.g. Head of Partnerships.
company
string
optional
Company name, shown in the accent colour.
department
string
optional
Team or department, shown beside the job title.
email
string
optional
Contact email address. Rendered as a mailto: link.
phone
string
optional
Office phone, in whatever format you want displayed.
mobile
string
optional
Mobile phone, in whatever format you want displayed.
website
string
optional
Website. A bare host like acme.com is turned into https://acme.com.
address
string
optional
Postal address, on one line.
disclaimer
string
optional
Small print under the signature — confidentiality notices, registration numbers.
cta_label
string
optional
Text on the call-to-action button. Needs cta_url to render.
cta_url
string
optional
Where the call-to-action button goes. Needs cta_label to render.
banner_image_url
string
optional
Public URL of a wide banner image shown under the signature.
banner_url
string
optional
Where clicking the banner goes.
logo_url
string
optional
Public URL of the company logo. Must be reachable without a login — mail clients fetch it directly.
photo_url
string
optional
Public URL of the portrait actually shown. This is the animated GIF when the designer made one; set it directly only if you are hosting your own image.
photo_source_url
string
optional
Public URL of the original un-animated photo, kept so the designer can re-render the animation later.
photo_shape
"circle" | "rounded" | "square" | "shards"
optional
Frame around the portrait. 'shards' cuts the photo into offset diagonal blades with gaps between them — baked into the image, so it needs the designer to regenerate the portrait rather than just setting this field.
Which movement the portrait was built with. Descriptive only on this path — the moving image itself is produced in the designer and referenced by photo_url; setting this alone does not animate anything.
verified
boolean
optional
Show a blue verified check beside the name. Decorative only — nothing is verified.
accent_color
string
optional
Brand colour as #rrggbb. Used for the company line, links, rules and the CTA button.
text_color
string
optional
Body text colour as #rrggbb.
socials
object[]
optional
Social links, rendered as a row of small icons. Replaces the whole list when supplied.
socials[].network
"linkedin" | "x" | "facebook" | "instagram" | "youtube" | "tiktok" | … 4 more