Skip to main content
PUT
Set Default Email Component

Set Default Email Component

You can change the footer every new email gets by writing the company’s default footer component. Sequence, campaign, and AI-generated emails clone this component when they are built, instead of the footer Sequenzy generates from your company profile. This replaces the whole component. Read the current one with Get Default Email Component first when you only mean to change part of it.
A default footer always keeps its unsubscribe link enabled. Transactional sends hide it at render time. Without application options, existing emails keep their saved footer. Use Preview Default Footer before applying to existing emails.

Request

string
required
Default slot to write. Currently only footer.
array
required
Blocks that make up the component. Must contain at least one block. Put block styling under styles; top-level style keys are normalized into styles.
string
Component name. Defaults to Default Footer when creating the footer default. Names are unique per company.
string
Optional human-readable description.
object
Optional selected scopes and includeCustomized boolean, matching your preview. Scopes accept sequences, campaigns, transactional, and templates.
string
Required with application scopes. Use the token returned by preview with identical blocks, metadata, and application options. Stale previews return 409 without writes.
Application requires admin access for personal keys, emails:write, each selected category’s write scope, and ab_tests:write for sequences or campaigns. Missing permissions return 403. Invalid request shapes return 422. Success also returns application with counts, affected items and skipped reasons. Unexpected failures return 500 with no partial application.

Responses