REST API and OpenAPI spec

The REST API behind every skill and SDK. Use the OpenAPI spec for toolchains, validation, and client generation.

API

Available

Get started

API reference

Install the API skill View docs OpenAPI spec

Contacts

POST /contacts/create

Add a contact to your audience

PUT /contacts/update

Update a contact by email or userId

GET /contacts/find

Find a contact by email or userId

POST /contacts/delete

Delete a contact

Events

POST /events/send

Send an event to trigger Workflows and lifecycle flows

Transactional emails

POST /transactional

Send a transactional email with data variables and attachments

GET /transactional-emails

List published transactional emails (paginated)

POST /transactional-emails

Create a transactional email

GET /transactional-emails/{transactionalId}

Get a transactional email

POST /transactional-emails/{transactionalId}

Update a transactional email

POST /transactional-emails/{transactionalId}/draft

Ensure a draft email message

POST /transactional-emails/{transactionalId}/publish

Publish a transactional email draft

Mailing lists

GET /lists

Get all mailing lists with id, name, description, and visibility

Contact properties

POST /contacts/properties

Create a contact property (name must be camelCase)

GET /contacts/properties

List all or custom contact properties

Suppression

GET /contacts/suppression

Check suppression status and removal quota for a contact

DELETE /contacts/suppression

Remove a contact from the suppression list (quota-limited)

Campaigns

GET /campaigns

List your campaigns

POST /campaigns

Create a draft campaign

GET /campaigns/{campaignId}

Get a campaign

POST /campaigns/{campaignId}

Update a campaign

Campaign groups

GET /campaign-groups

List campaign groups

POST /campaign-groups

Create a campaign group

GET /campaign-groups/{campaignGroupId}

Get a campaign group

POST /campaign-groups/{campaignGroupId}

Update a campaign group

Transactional groups

GET /transactional-groups

List transactional groups

POST /transactional-groups

Create a transactional group

GET /transactional-groups/{transactionalGroupId}

Get a transactional group

POST /transactional-groups/{transactionalGroupId}

Update a transactional group

Email messages

GET /email-messages/{emailMessageId}

Get an email message and its content

POST /email-messages/{emailMessageId}

Update an email message

POST /email-messages/{emailMessageId}/preview

Send a preview of an email message

GET /email-messages/{emailMessageId}/guardian

Run Guardian checks on an email message

Themes

GET /themes

List your themes

GET /themes/{themeId}

Get a theme

POST /themes

Create a theme

POST /themes/{themeId}

Update a theme

Components

GET /components

List reusable components

GET /components/{componentId}

Get a component

POST /components

Create a reusable component

POST /components/{componentId}

Update a component

Audience segments

GET /audience-segments

List audience segments

GET /audience-segments/{audienceSegmentId}

Get an audience segment

POST /audience-segments

Create an audience segment

Event patterns

GET /event-patterns

List event patterns

GET /event-patterns/by-name/{eventName}

Get an event pattern by name

GET /event-patterns/{eventPatternId}

Get an event pattern by ID

Workflows

GET /workflows

List your workflows

GET /workflows/{workflowId}

Get a simplified workflow

GET /workflows/{workflowId}/nodes/{nodeId}

Get workflow node details

POST /workflows

Create a workflow

POST /workflows/{workflowId}

Update a workflow

POST /workflows/{workflowId}/mailing-list

Change a workflow mailing list

POST /workflows/{workflowId}/nodes

Create a workflow node

POST /workflows/{workflowId}/nodes/{nodeId}

Update a workflow node

POST /workflows/{workflowId}/nodes/{nodeId}/add-branch

Add a branch below a node

POST /workflows/{workflowId}/nodes/{nodeId}/reroute

Reroute a node connection

DELETE /workflows/{workflowId}/nodes/{nodeId}

Delete one workflow node

DELETE /workflows/{workflowId}/nodes/{nodeId}/recursive

Delete a node and its downstream path

Uploads

POST /uploads

Create an upload

POST /uploads/{id}/complete

Complete an upload

Other

GET /api-key

Test your API key, returns team name

GET /dedicated-sending-ips

Get your dedicated sending IP addresses

Guides

Company

Product

Resources

Connect

All systems operational

Resources

Connect

Company

Product

All systems operational

Company

Product

Resources

Connect

All systems operational

Start

Book a demo

Demo