Loops

Remove a suppressed contact from the suppression list by `email` or `userId`. Include only one query parameter.

Test your API key

Retrieve a paginated list of audience segments, most recently created first.

Retrieve a single audience segment by ID.

Retrieve a paginated list of campaign groups, most recently created first.

Retrieve a single campaign group by ID.

Retrieve a paginated list of campaigns.

Retrieve a single campaign by ID.

Retrieve a paginated list of email components.

Retrieve a single component by ID.

Search for a contact by `email` or `userId`. Only one parameter is allowed.

Retrieve a list of your account's contact properties.<br>Use the `list` parameter to query "all" or "custom" properties.

Retrieve suppression status and removal quota for a contact by `email` or `userId`. Include only one query parameter.

Retrieve a list of Loops' dedicated sending IP addresses.

Retrieve an email message, including its compiled LMX content.

Validate an email message's content against Guardian rules and return any errors and warnings. Errors must be resolved before the email can be published, warnings are advisory.

Retrieve a list of your account's mailing lists.

Retrieve a paginated list of email themes, most recently created first.

Retrieve a single theme by ID.

Get a list of published transactional emails.

Retrieve a paginated list of transactional emails, most recently created first.

Retrieve a single transactional email by ID.

Retrieve a paginated list of transactional groups, most recently created first.

Retrieve a single transactional group by ID.

Retrieve a workflow graph with node type names, connections, and selected display fields.

Retrieve detailed data for a single workflow node.

Retrieve a paginated list of workflows.

Create a new campaign group.

Update a campaign group's name or description. At least one field must be provided. The reserved "Unsorted" group cannot be edited.

Create a new draft campaign. An empty email message is created automatically and its `emailMessageId` is returned. Use the `/email-messages/{emailMessageId}` endpoint to set subject, sender, preview text, and LMX content. The audience (mailing list, segment, or filter), group, and scheduling can be set on create or later via update.

Update a draft campaign's name, group, audience (mailing list, segment, or filter), or scheduling. At least one field must be provided. Campaigns can only be updated while in draft status.

Create a new email component from an LMX body.

Update a component's name and/or body. When the `lmx` body changes, the update cascades to every email using this component, and `affectedEmailCount` reports how many were affected. A change that would introduce a dynamic variable an email using the component cannot use is rejected.

Add a contact to your audience.

Delete a contact by `email` or `userId`.

Add a contact property to your team.

Update fields on an email message (subject, preview text, sender, LMX content). The campaign must be in draft status. Supply `expectedRevisionId` matching the current `contentRevisionId` — the server rejects mismatched revisions with 409.

Send a test preview of an email message to one or more addresses. The accepted variable fields depend on the parent's type - campaign previews accept `contactProperties`, workflow previews accept `contactProperties` and `eventProperties`, and transactional previews accept `dataVariables`. Supplying a field the parent cannot reference is rejected with 400.

Send events to trigger emails in Loops.

Create a new email theme.

Update a theme's name and/or styles. When `styles` change, the update cascades to every email using this theme, and `affectedEmailCount` in the response reports how many emails were affected. Manual style edits made on individual emails are preserved: the cascade only changes properties an email has not overridden. A per-email override is removed only when it becomes identical to the theme's new value, after which that email follows the theme for that property.

Send a transactional email to a contact.<br>Please [email us](mailto:[email protected]) to enable attachments on your account before using them with the API.

Create a new transactional email. An empty draft email message is created automatically and its `draftEmailMessageId` is returned. Use the `/api/v1/email-messages/{emailMessageId}` endpoint to set subject, sender, preview text, and LMX content, then call `/api/v1/transactional-emails/{transactionalId}/publish` to publish.

Update a transactional email by ID.

Ensure the transactional email has a draft email message. If a draft already exists it is returned unchanged; otherwise a new empty draft is created (seeded from the most recent published version when present). Use `/v1/email-messages/{emailMessageId}` to edit the draft's content.

Publish the transactional email's current draft email message. The draft becomes the published version and the draft is cleared.

Create a new transactional group.

Update a transactional group's name or description. At least one field must be provided. The reserved "Unsorted" group cannot be edited.

Request a pre-signed URL to upload an image asset. Upload the file with an HTTP `PUT` to the returned `presignedUrl` (sending the same `Content-Type` and `Content-Length`), then call `/uploads/{id}/complete` to finalize the asset.

Finalize an asset after the file has been uploaded to the pre-signed URL. Returns the public URL of the uploaded asset.

Update a contact by `email` or `userId`. You must provide one of these parameters.<br>If you want to update a contact’s email address, the contact will first need a `userId` value. You can then make a request containing the userId field along with an updated email address.