/loops | Type: Application | PCID required: Yes
Tools
loops_complete_upload
Complete an upload Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The emailAssetId returned when the upload was created. |
loops_create_campaign
Create a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The campaign name. |
loops_create_contact
Create a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | The email value |
firstName | string | No | — | First Name |
lastName | string | No | — | Last Name |
mailingLists | object | No | — | An object of mailing list IDs and boolean subscription statuses. |
subscribed | boolean | No | — | The subscribed value |
userGroup | string | No | — | User Group |
userId | string | No | — | User Id |
loops_create_contact_property
Create a contact property Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name value |
type | string | Yes | — | The type value |
loops_create_transactional_email
Create a transactional email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name of the transactional email. |
loops_create_upload
Create an upload Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contentLength | integer | Yes | — | The size of the file in bytes. Must be a positive integer no greater than 4,000,000 bytes. |
contentType | string | Yes | — | The MIME type of the file to upload. Supported types are image/jpeg, image/png, image/gif and image/webp. |
loops_delete_contact
Delete a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | The email value |
userId | string | No | — | User Id |
loops_ensure_transactional_email_draft
Ensure a draft email message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
transactionalId | string | Yes | — | The ID of the transactional email. |
loops_find_contact
Find a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Email address (URI-encoded) |
userId | string | No | — | User Id |
loops_get_campaign
Get a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaignId | string | Yes | — | The ID of the campaign. |
loops_get_component
Get a component Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
componentId | string | Yes | — | The ID of the component. |
loops_get_contact_suppression
Get suppression status for a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Email address (URI-encoded) |
userId | string | No | — | User Id |
loops_get_email_message
Get an email message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
emailMessageId | string | Yes | — | The ID of the email message. |
loops_get_theme
Get a theme Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
themeId | string | Yes | — | The ID of the theme. |
loops_get_transactional_email
Get a transactional email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
transactionalId | string | Yes | — | The ID of the transactional email. |
loops_list_campaigns
List campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perPage | string | No | — | How many results to return in each request. Must be between 10 and 50. Default is 20. |
cursor | string | No | — | A cursor to return a specific page of results. Cursors can be found from the pagination.nextCursor value in each response. |
loops_list_components
List components Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perPage | string | No | — | How many results to return in each request. Must be between 10 and 50. Default is 20. |
cursor | string | No | — | A cursor to return a specific page of results. Cursors can be found from the pagination.nextCursor value in each response. |
loops_list_contact_properties
Get a list of contact properties Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list | string | No | — | “all” (default) or “custom” |
loops_list_dedicated_sending_ips
Get dedicated sending IP addressesloops_list_mailing_lists
Get a list of mailing listsloops_list_themes
List themes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perPage | string | No | — | How many results to return in each request. Must be between 10 and 50. Default is 20. |
cursor | string | No | — | A cursor to return a specific page of results. Cursors can be found from the pagination.nextCursor value in each response. |
loops_list_transactional_email_definitions
List transactional emails Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perPage | string | No | — | How many results to return in each request. Must be between 10 and 50. Default is 20. |
cursor | string | No | — | A cursor to return a specific page of results. Cursors can be found from the pagination.nextCursor value in each response. |
loops_list_transactional_emails
List transactional emails Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perPage | string | No | — | How many results to return in each request. Must be between 10 and 50. Default is 20. |
cursor | string | No | — | A cursor, to return a specific page of results. Cursors can be found from the pagination.nextCursor value in each response. |
loops_publish_transactional_email_draft
Publish a transactional email draft Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
transactionalId | string | Yes | — | The ID of the transactional email. |
loops_remove_contact_suppression
Remove a contact from suppression list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Email address (URI-encoded) |
userId | string | No | — | User Id |
loops_send_event
Send an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Idempotency-Key | string | No | — | Include a unique ID for this request (maximum 100 characters) to avoid duplicate events. More info |
email | string | No | — | The email value |
eventName | string | Yes | — | Event Name |
eventProperties | object | No | — | An object containing event property data for the event, available in emails sent by the event. |
mailingLists | object | No | — | An object of mailing list IDs and boolean subscription statuses. |
userId | string | No | — | User Id |
loops_send_transactional_email
Send a transactional email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Idempotency-Key | string | No | — | Include a unique ID for this request (maximum 100 characters) to avoid duplicate emails. More info |
addToAudience | boolean | No | — | If true, a contact will be created in your audience using the email value (if a matching contact doesn’t already exist). |
attachments | object[] | No | — | A list containing file objects to be sent along with an email message. |
dataVariables | object | No | — | An object containing contact data as defined by the data variables added to the transactional email template. |
email | string | Yes | — | The email value |
transactionalId | string | Yes | — | The ID of the transactional email to send. |
loops_test_api_key
Test your API keyloops_update_campaign
Update a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaignId | string | Yes | — | The ID of the campaign. |
name | string | Yes | — | The name value |
loops_update_contact
Update a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | The email value |
firstName | string | No | — | First Name |
lastName | string | No | — | Last Name |
mailingLists | object | No | — | An object of mailing list IDs and boolean subscription statuses. |
subscribed | boolean | No | — | The subscribed value |
userGroup | string | No | — | User Group |
userId | string | No | — | User Id |
loops_update_email_message
Update an email message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
emailMessageId | string | Yes | — | The ID of the email message. |
expectedRevisionId | string | No | — | The contentRevisionId you last fetched. Used for optimistic concurrency — the request is rejected with 409 if the server’s revision has advanced. |
fromEmail | string | No | — | The sender username (without @ or domain). The team’s sending domain is appended automatically. |
fromName | string | No | — | From Name |
lmx | string | No | — | The email body serialized as LMX. Styles must be embedded in the LMX <Style /> tag. |
previewText | string | No | — | Preview Text |
replyToEmail | string | No | — | Reply-to email. Must be empty or a valid email address. |
subject | string | No | — | The subject value |
loops_update_transactional_email
Update a transactional email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
transactionalId | string | Yes | — | The ID of the transactional email. |
name | string | Yes | — | The name value |

