Skip to main content
Server path: /loops | Type: Application | PCID required: Yes

Tools

ToolDescription
loops_complete_uploadComplete an upload
loops_create_campaignCreate a campaign
loops_create_contactCreate a contact
loops_create_contact_propertyCreate a contact property
loops_create_transactional_emailCreate a transactional email
loops_create_uploadCreate an upload
loops_delete_contactDelete a contact
loops_ensure_transactional_email_draftEnsure a draft email message
loops_find_contactFind a contact
loops_get_campaignGet a campaign
loops_get_componentGet a component
loops_get_contact_suppressionGet suppression status for a contact
loops_get_email_messageGet an email message
loops_get_themeGet a theme
loops_get_transactional_emailGet a transactional email
loops_list_campaignsList campaigns
loops_list_componentsList components
loops_list_contact_propertiesGet a list of contact properties
loops_list_dedicated_sending_ipsGet dedicated sending IP addresses
loops_list_mailing_listsGet a list of mailing lists
loops_list_themesList themes
loops_list_transactional_email_definitionsList transactional emails
loops_list_transactional_emailsList transactional emails
loops_publish_transactional_email_draftPublish a transactional email draft
loops_remove_contact_suppressionRemove a contact from suppression list
loops_send_eventSend an event
loops_send_transactional_emailSend a transactional email
loops_test_api_keyTest your API key
loops_update_campaignUpdate a campaign
loops_update_contactUpdate a contact
loops_update_email_messageUpdate an email message
loops_update_transactional_emailUpdate a transactional email

loops_complete_upload

Complete an upload Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe emailAssetId returned when the upload was created.

loops_create_campaign

Create a campaign Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe campaign name.

loops_create_contact

Create a contact Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesThe email value
firstNamestringNoFirst Name
lastNamestringNoLast Name
mailingListsobjectNoAn object of mailing list IDs and boolean subscription statuses.
subscribedbooleanNoThe subscribed value
userGroupstringNoUser Group
userIdstringNoUser Id

loops_create_contact_property

Create a contact property Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name value
typestringYesThe type value

loops_create_transactional_email

Create a transactional email Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name of the transactional email.

loops_create_upload

Create an upload Parameters:
ParameterTypeRequiredDefaultDescription
contentLengthintegerYesThe size of the file in bytes. Must be a positive integer no greater than 4,000,000 bytes.
contentTypestringYesThe 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:
ParameterTypeRequiredDefaultDescription
emailstringNoThe email value
userIdstringNoUser Id

loops_ensure_transactional_email_draft

Ensure a draft email message Parameters:
ParameterTypeRequiredDefaultDescription
transactionalIdstringYesThe ID of the transactional email.

loops_find_contact

Find a contact Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoEmail address (URI-encoded)
userIdstringNoUser Id

loops_get_campaign

Get a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaignIdstringYesThe ID of the campaign.

loops_get_component

Get a component Parameters:
ParameterTypeRequiredDefaultDescription
componentIdstringYesThe ID of the component.

loops_get_contact_suppression

Get suppression status for a contact Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoEmail address (URI-encoded)
userIdstringNoUser Id

loops_get_email_message

Get an email message Parameters:
ParameterTypeRequiredDefaultDescription
emailMessageIdstringYesThe ID of the email message.

loops_get_theme

Get a theme Parameters:
ParameterTypeRequiredDefaultDescription
themeIdstringYesThe ID of the theme.

loops_get_transactional_email

Get a transactional email Parameters:
ParameterTypeRequiredDefaultDescription
transactionalIdstringYesThe ID of the transactional email.

loops_list_campaigns

List campaigns Parameters:
ParameterTypeRequiredDefaultDescription
perPagestringNoHow many results to return in each request. Must be between 10 and 50. Default is 20.
cursorstringNoA 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:
ParameterTypeRequiredDefaultDescription
perPagestringNoHow many results to return in each request. Must be between 10 and 50. Default is 20.
cursorstringNoA 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:
ParameterTypeRequiredDefaultDescription
liststringNo“all” (default) or “custom”

loops_list_dedicated_sending_ips

Get dedicated sending IP addresses

loops_list_mailing_lists

Get a list of mailing lists

loops_list_themes

List themes Parameters:
ParameterTypeRequiredDefaultDescription
perPagestringNoHow many results to return in each request. Must be between 10 and 50. Default is 20.
cursorstringNoA 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:
ParameterTypeRequiredDefaultDescription
perPagestringNoHow many results to return in each request. Must be between 10 and 50. Default is 20.
cursorstringNoA 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:
ParameterTypeRequiredDefaultDescription
perPagestringNoHow many results to return in each request. Must be between 10 and 50. Default is 20.
cursorstringNoA 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:
ParameterTypeRequiredDefaultDescription
transactionalIdstringYesThe ID of the transactional email.

loops_remove_contact_suppression

Remove a contact from suppression list Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoEmail address (URI-encoded)
userIdstringNoUser Id

loops_send_event

Send an event Parameters:
ParameterTypeRequiredDefaultDescription
Idempotency-KeystringNoInclude a unique ID for this request (maximum 100 characters) to avoid duplicate events. More info
emailstringNoThe email value
eventNamestringYesEvent Name
eventPropertiesobjectNoAn object containing event property data for the event, available in emails sent by the event.
mailingListsobjectNoAn object of mailing list IDs and boolean subscription statuses.
userIdstringNoUser Id

loops_send_transactional_email

Send a transactional email Parameters:
ParameterTypeRequiredDefaultDescription
Idempotency-KeystringNoInclude a unique ID for this request (maximum 100 characters) to avoid duplicate emails. More info
addToAudiencebooleanNoIf true, a contact will be created in your audience using the email value (if a matching contact doesn’t already exist).
attachmentsobject[]NoA list containing file objects to be sent along with an email message.
dataVariablesobjectNoAn object containing contact data as defined by the data variables added to the transactional email template.
emailstringYesThe email value
transactionalIdstringYesThe ID of the transactional email to send.

loops_test_api_key

Test your API key

loops_update_campaign

Update a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaignIdstringYesThe ID of the campaign.
namestringYesThe name value

loops_update_contact

Update a contact Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoThe email value
firstNamestringNoFirst Name
lastNamestringNoLast Name
mailingListsobjectNoAn object of mailing list IDs and boolean subscription statuses.
subscribedbooleanNoThe subscribed value
userGroupstringNoUser Group
userIdstringNoUser Id

loops_update_email_message

Update an email message Parameters:
ParameterTypeRequiredDefaultDescription
emailMessageIdstringYesThe ID of the email message.
expectedRevisionIdstringNoThe contentRevisionId you last fetched. Used for optimistic concurrency — the request is rejected with 409 if the server’s revision has advanced.
fromEmailstringNoThe sender username (without @ or domain). The team’s sending domain is appended automatically.
fromNamestringNoFrom Name
lmxstringNoThe email body serialized as LMX. Styles must be embedded in the LMX <Style /> tag.
previewTextstringNoPreview Text
replyToEmailstringNoReply-to email. Must be empty or a valid email address.
subjectstringNoThe subject value

loops_update_transactional_email

Update a transactional email Parameters:
ParameterTypeRequiredDefaultDescription
transactionalIdstringYesThe ID of the transactional email.
namestringYesThe name value