Constant Contact

constant_contact

Email marketing and automation platform for small businesses

Marketing Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (93)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Account Email AddressCONSTANT_CONTACT_ADD_ACCOUNT_EMAIL_ADDRESSAcción

Add a new email address to a Constant Contact account. Use this action when you need to associate an additional email address with a Constant Contact account. After adding an email address, Constant Contact sends a confirmation email to the new address. You can only use email addresses with CONFIRMED status to create email campaigns. Requires the 'account_update' OAuth scope.

Parámetros de entrada

email_addressstringObligatorio
The new email address you want to add to a Constant Contact account.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Contact TaggingsCONSTANT_CONTACT_ADD_CONTACT_TAGGINGSAcción

Add Tags to Contacts. Use this action when you need to asynchronously add one or more tags to contacts that meet your specified contact filtering criteria. The action creates an asynchronous activity that processes the tag addition. The activity returns an activity_id that can be used to track the status of the operation.

Parámetros de entrada

sourceobjectObligatorio
Select the source used to identify contacts to which a tag is added or removed. Source types are mutually exclusive.
excludeobject
Contacts to exclude from the tag operation.
tag_idsstring[]Obligatorio
An array of tags (tag_id) to add to all contacts meeting the specified source criteria.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add list membershipsCONSTANT_CONTACT_ADD_LIST_MEMBERSHIPSAcción

Add Contacts to Lists creates an activity to add contacts to one or more contact lists. Use this action when you need to bulk-add contacts to Constant Contact lists. The action supports adding contacts by individual contact IDs, all active contacts, contacts from existing lists, segments, engagement levels, or tags. Up to 50 lists and 500 contacts can be specified per request. This is an asynchronous operation that returns an activity ID for tracking progress.

Parámetros de entrada

sourceobjectObligatorio
The source object specifies which contacts you are adding to your targeted lists.
excludeobject
Contacts to exclude from being added to the target list.
list_idsstring[]Obligatorio
Specifies which lists (up to 50) you are adding your source contacts to.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Copy EventCONSTANT_CONTACT_COPY_EVENTAcción

POST (copy) an existing event in Constant Contact. Use this action when you need to duplicate an existing event to create a new event with similar configuration. The copied event will have a new event_id but will retain all settings, campaigns, and configurations from the source event. You must provide a unique name for the new event. Optionally, you can specify which campaign activities to copy (if not specified, all activities are copied). This action is useful for recurring events or when creating event series with similar configurations. Note: The new event name must be unique within the account.

Parámetros de entrada

event_idstringObligatorio
The unique ID of the event to copy. This is a UUID string.
target_event_namestringObligatorio
The name for the copied event. Must be unique for the account.
source_campaign_activitiesstring[]
Optional array of campaign activity UUIDs to copy. If not provided, all activities are copied.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Count Contact ConsentsCONSTANT_CONTACT_COUNT_CONTACT_CONSENTSAcción

GET contact consent counts for a Constant Contact account. Use this action when you need to retrieve aggregate counts of contacts by consent status, including explicitly confirmed, implicitly confirmed, pending, unsubscribed, and total contacts. Optionally include counts of newly subscribed contacts from the last 30 days by specifying the include parameter with 'new_subscriber'. This is a read-only operation that returns summary statistics about contact consent states.

Parámetros de entrada

includestringenum
Valid values for the include parameter.
new_subscriber

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ContactCONSTANT_CONTACT_CREATE_CONTACTAcción

Create a new contact in Constant Contact. Use this action when you need to add a new contact to your Constant Contact account. The contact's email address must be unique within the account. You can optionally include the contact's name, phone numbers, addresses, and assign them to lists or tags. This action requires the 'contact_update' OAuth scope.

Parámetros de entrada

tag_idsstring[]
List of tag IDs to apply to the contact.
list_idsstring[]
List of list IDs to add the contact to.
job_titlestring
The contact's job title.
last_namestring
The contact's last name.
first_namestring
The contact's first name.
company_namestring
The contact's company name.
create_sourcestring
The source where the contact was created. Values: 'Contact' (manually created), 'API' (created via API), 'Import' (bulk import), 'Survey' (from survey).
custom_fieldsobject[]
List of custom field key-value pairs. Example: [{'custom_field_id': 'cf1', 'value': 'vip'}]
email_addressobjectObligatorio
The contact's email address object. Required and must be unique within the account.
phone_numbersobject[]
List of phone numbers associated with the contact.
street_addressesobject[]
List of street addresses associated with the contact.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create contact from sign-up formCONSTANT_CONTACT_CREATE_CONTACT_FROM_SIGN_UP_FORMAcción

Create or Update a Contact via sign-up form. Use this action when you need to add a new contact to Constant Contact through a sign-up form submission. The action identifies contacts by email address - if the email already exists, the contact will be updated; if new, a contact will be created. At least one list_id must be provided in list_memberships to assign the contact to a list. If using SMS channel, the sms_channel object with country_code, dial_code, sms_address, and sms_channel_consents is required instead of email_address and list_memberships.

Parámetros de entrada

job_titlestring
The job title of the contact.
last_namestring
The last name of the contact.
first_namestring
The first name of the contact.
anniversarystring
The anniversary date for the contact. Valid date formats are MM/DD/YYYY, M/D/YYYY, YYYY/MM/DD, YYYY/M/D, YYYY-MM-DD, YYYY-M-D, M-D-YYYY, or M-DD-YYYY.
sms_channelobject
The contact's SMS details.
birthday_dayinteger
The day value for the contact's birthday. Valid values are from 1 through 31. The birthday_day property is required if you use birthday_month.
company_namestring
The name of the company where the contact works.
phone_numberstring
The phone number for the contact.
custom_fieldsobject[]
The custom fields you want to add to the contact as an array of up to 50 custom field objects.
email_addressstringObligatorio
The email address for the contact. This method identifies each unique contact using their email address. If the email address exists in the account, this method updates the contact. If the email address is new, this method creates a new contact.
birthday_monthinteger
The month value for the contact's birthday. Valid values are from 1 through 12. The birthday_month property is required if you use birthday_day.
street_addressobject
The street address for the contact.
list_membershipsstring[]Obligatorio
The contact lists you want to add the contact to as an array of up to 50 contact list_id values. You must include at least one list_id.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Contact ListCONSTANT_CONTACT_CREATE_CONTACT_LISTAcción

Create a new contact list in Constant Contact. Use this action when you need to create a new contact list to organize and manage your contacts. The list name must be unique within your account. You can optionally provide a description and mark the list as a favorite. Once created, contacts can be added to the list using the appropriate action.

Parámetros de entrada

namestringObligatorio
The contact list name. Must be unique and is required. Maximum 255 characters.
favoriteboolean
Boolean flag indicating whether the contact list is marked as a favorite.
descriptionstring
A description of the contact list. Maximum 255 characters.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create contact tagCONSTANT_CONTACT_CREATE_CONTACT_TAGAcción

POST (Create) a Tag. Use this action when you need to create a new contact tag in Constant Contact. Tag names must be unique within the account. Attempting to create a tag with a duplicate name will result in an error.

Parámetros de entrada

namestringObligatorio
The name of the tag. Tag names must be unique within the account.
tag_sourceinteger
The source of the tag. For example, 2 typically indicates a user-created tag.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Custom FieldCONSTANT_CONTACT_CREATE_CUSTOM_FIELDAcción

Create a new custom field for contacts in Constant Contact. Use when you need to add a custom data field to store additional information about contacts, such as preferences, custom attributes, or extended contact details. The custom field can store different types of data including strings, numbers, dates, currency values, and select options. Required fields are 'label' (the display name) and 'type' (the data type to store).

Parámetros de entrada

typestringObligatorio
The type of data to store in the custom field.
labelstringObligatorio
The custom field name to display in the UI (free-form text).
choicesobject[]
Array of choices for custom fields of type 'single_select' or 'multi_select'. Maximum number of elements for 'checkbox' and 'radio' display types is 20. Maximum number of elements for a 'dropdown' is 100.
versioninteger
Available if data type is 'date'. Displays '1' if using legacy date fields where values are stored as strings. Displays '2' if using new date fields where values are stored as actual dates.
metadataobject
Additional metadata options for custom fields.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Email CampaignCONSTANT_CONTACT_CREATE_EMAIL_CAMPAIGNAcción

Create a new email campaign in Constant Contact. Use this action when you need to create a new email marketing campaign. The campaign will be created in DRAFT status by default. You must include a unique name for the campaign and at least one email campaign activity containing the email content (from_email, from_name, reply_to_email, subject, and html_content). After creation, the campaign can be scheduled or sent using appropriate actions. This action is suitable for creating marketing campaigns, newsletters, or promotional emails. Note: You must validate your sending email address in Constant Contact before you can use it in a campaign. Include [[trackingImage]] in your HTML content for open tracking.

Parámetros de entrada

namestringObligatorio
The name of the email campaign. Must be unique within the account. Maximum 255 characters.
email_campaign_activitiesobject[]Obligatorio
Array of email campaign activities. At least one activity is required.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create EventCONSTANT_CONTACT_CREATE_EVENTAcción

Create a new event with default settings in Constant Contact. Use this action when you need to create a new event in Constant Contact. The event is created with default settings including a registration form and landing page. The event will be created in DRAFT status and can be updated later before publishing. This action requires the 'event_update' OAuth scope.

Parámetros de entrada

namestringObligatorio
The name of the event. If not provided, a default name will be generated.
end_datestring
Event end date and time in ISO 8601 format (e.g., '2026-06-01T12:00:00-04:00').
locationobject
Location object for an event.
start_datestring
Event start date and time in ISO 8601 format (e.g., '2026-06-01T10:00:00-04:00').
descriptionstring
A description of the event.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Resend to Non-openersCONSTANT_CONTACT_CREATE_RESEND_TO_NON_OPENERSAcción

Create a resend to non-openers campaign activity for an email campaign. Use this action when you need to resend an email campaign to contacts who did not open the original email. You can schedule the resend using delay_days or delay_minutes, and optionally provide a different subject line for the resend. This action is useful for re-engaging contacts who missed your initial campaign. Requires the 'campaign_data' OAuth scope.

Parámetros de entrada

delay_daysinteger
The number of days to wait before Constant Contact resends the email. Valid values include 1 to 10 days. This property is mutually exclusive with delay_minutes.
delay_minutesinteger
The number of minutes to wait before Constant Contact resends the email. Valid values include a minimum of 720 (12 hours) and a maximum of 14,400 minutes (10 days). This property is mutually exclusive with delay_days.
resend_subjectstringObligatorio
The subject line used when resending the email campaign activity.
campaign_activity_idstringObligatorio
The unique ID for the primary email campaign activity.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Social PostCONSTANT_CONTACT_CREATE_SOCIAL_POSTAcción

Create a new social media post campaign. Use this action when you need to create a new social media post campaign in Constant Contact. This action allows you to create posts with content for multiple social profiles. Set the status to 'DRAFT' to save without publishing, or 'SCHEDULED' to schedule for publication at a specific time. This action requires the 'campaign_data' OAuth scope.

Parámetros de entrada

namestring
Campaign name for this post. Optional on creation. If not provided, a default name will be generated. The value provided will be sanitized before saving.
statusstringObligatorioenum
The status of the post on creation. Use 'DRAFT' to save without publishing, or 'SCHEDULED' to schedule for publication.
DRAFTSCHEDULEDEXECUTINGACTIVEPAUSEDSUSPENDEDREMOVEDDONEERROR
profile_postsobject[]Obligatorio
The list of per-profile posts that make up this campaign. Each entry specifies the content to post and the profiles to post it to. At least one profile_post is required.
scheduled_timestring
The date and time to publish the post, in ISO-8601 format. Only applies when status is 'SCHEDULED'. If not specified for a scheduled post, the publish job is scheduled to execute immediately.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete contactCONSTANT_CONTACT_DELETE_CONTACTAcción

DELETE a specific contact from your Constant Contact account. Use this action when you need to permanently remove a contact from your account. This action is irreversible — once deleted, the contact cannot be recovered.

Parámetros de entrada

contact_idstringObligatorio
The unique identifier of the contact to delete, in UUID format.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Contact ListCONSTANT_CONTACT_DELETE_CONTACT_LISTAcción

Permanently deletes a contact list from Constant Contact by its ID. This action is irreversible — once a contact list is deleted, it cannot be recovered. Use this action when you need to remove outdated or unwanted contact lists. Note that deleting a list does not delete the contacts that were members of the list. The API returns 204 No Content on successful deletion with an empty response body.

Parámetros de entrada

list_idstringObligatorio
Unique ID of the contact list to delete. This is a UUID string (e.g., '1b48fb08-4abf-11f1-8f20-02420a320003').

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create contact delete activityCONSTANT_CONTACT_DELETE_CONTACTS_ACTIVITYAcción

Delete multiple contacts in bulk by submitting a contact_delete activity. Use this action when you need to delete multiple contacts at once by specifying contact IDs (up to 500) or list IDs (up to 50). The contacts are processed asynchronously and the response returns an activity_id to track the deletion progress. This action is irreversible — deleted contacts cannot be recovered once removed.

Parámetros de entrada

list_idsstring[]
The contacts on the lists (up to 50) specified will be deleted; mutually exclusive with contact_ids.
contact_idsstring[]
Specify up to 500 contacts by contact_id to delete; mutually exclusive with list_ids.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete contact tagCONSTANT_CONTACT_DELETE_CONTACT_TAGAcción

Delete a specific contact tag from your Constant Contact account. Use this action when you need to remove an existing tag from your account. This action is irreversible — once deleted, the tag cannot be recovered.

Parámetros de entrada

tag_idstringObligatorio
The unique identifier of the contact tag to delete, in UUID format.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete contact tagsCONSTANT_CONTACT_DELETE_CONTACT_TAGSAcción

Delete one or more tags from contacts in Constant Contact. Use this action when you need to remove tags from contacts in bulk. The operation creates an asynchronous activity that processes the tag deletions. The activity_id returned can be used to track the status of the deletion operation. Note: This is an irreversible operation — once tags are deleted from contacts, they cannot be easily recovered.

Parámetros de entrada

tag_idsstring[]Obligatorio
The list of tag IDs to delete. Maximum 500 tags per request.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete custom fieldCONSTANT_CONTACT_DELETE_CUSTOM_FIELDAcción

DELETE a specific contact custom field from your Constant Contact account. Use this action when you need to permanently remove a custom field that is no longer needed. This action is irreversible — the custom field cannot be recovered once deleted.

Parámetros de entrada

custom_field_idstringObligatorio
The unique identifier of the custom field to delete.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete custom fieldsCONSTANT_CONTACT_DELETE_CUSTOM_FIELDSAcción

Delete one or more custom fields from a Constant Contact account. Use when you need to remove outdated or unnecessary custom fields from your contact data. The deletion is processed asynchronously as an activity, so check the activity status to verify completion. This action is irreversible once the activity is processed.

Parámetros de entrada

custom_field_idsstring[]Obligatorio
The array of custom field IDs to delete.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Email CampaignCONSTANT_CONTACT_DELETE_EMAIL_CAMPAIGNAcción

DELETE an Email Campaign from your Constant Contact account. Use this action when you need to permanently remove an email campaign that is no longer needed or was created in error. This action is irreversible — the email campaign cannot be recovered once deleted. The API returns 204 No Content on successful deletion with an empty response body.

Parámetros de entrada

campaign_idstringObligatorio
The unique identifier of the email campaign to delete, in UUID format.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete contact list activityCONSTANT_CONTACT_DELETE_LIST_ACTIVITYAcción

Delete one or more contact lists from your Constant Contact account by submitting a list delete activity. Use this action when you need to permanently remove contact lists that are no longer needed. This action is irreversible — once deleted, contact lists cannot be recovered. The deletion is processed as an async activity, and you can track the status using the activity_id returned.

Parámetros de entrada

list_idsstring[]Obligatorio
An array of contact list UUIDs to delete. Maximum 100 list IDs allowed per request.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete SegmentCONSTANT_CONTACT_DELETE_SEGMENTAcción

Permanently deletes a segment from Constant Contact by its ID. Use this action when you need to remove outdated or unwanted segments from your Constant Contact account. This action is irreversible — once a segment is deleted, it cannot be recovered. Note that deleting a segment does not delete the contacts that were members of the segment. The API returns 204 No Content on successful deletion with an empty response body.

Parámetros de entrada

segment_idintegerObligatorio
The system-generated unique ID that identifies a segment to delete.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Export ContactsCONSTANT_CONTACT_EXPORT_CONTACTSAcción

Create a bulk activity that exports contacts to a CSV file. Use this action when you need to export contacts from your Constant Contact account to a CSV file for backup, migration, or analysis purposes. You can export all contacts or filter by specific contact lists, segments, or status. The exported file will be available for download once the activity status changes to COMPLETE.

Parámetros de entrada

statusstring
The status of contacts to export. If not specified, exports contacts of all statuses. Valid values: 'active', 'unconfirmed', 'remove_failed', 'removing'.
list_idsstring[]
The unique identifiers of the contact lists to export. Only contacts from the specified lists will be included in the export. If not specified, exports all contacts.
segment_idstring
The unique identifier of a contact segment to export. Only contacts matching the segment criteria will be included. Cannot be used together with list_ids.
contact_fieldsstring[]
The contact fields to include in the exported CSV file. Common values include: email_address, first_name, last_name, phone_number, street_address, city, state, postal_code, country, company_name, job_title. If not specified, exports all available contact fields.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get account physical addressCONSTANT_CONTACT_GET_ACCOUNT_PHYSICAL_ADDRESSAcción

GET the Physical Address for the Account. Use this action when you need to retrieve the physical mailing address associated with the Constant Contact account, such as for compliance verification or contact information display.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get account summaryCONSTANT_CONTACT_GET_ACCOUNT_SUMMARYAcción

GET a summary of account details for a Constant Contact account. Use when you need to retrieve account information including company name, contact email, phone number, website, and optionally physical address or company logo.

Parámetros de entrada

extra_fieldsstring
Include additional fields in the response. Use 'physical_address' and/or 'company_logo' as values. Multiple values should be comma-separated.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get activity statusCONSTANT_CONTACT_GET_ACTIVITY_STATUSAcción

GET the status of a specific bulk activity. Use this action when you need to check the processing status of a bulk activity such as contact imports, file exports, or list membership changes in Constant Contact.

Parámetros de entrada

activity_idstringObligatorio
The unique ID of the activity to retrieve status for.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get contactCONSTANT_CONTACT_GET_CONTACTAcción

GET a contact by their unique ID. Use this action when you need to retrieve detailed information about a specific contact in your Constant Contact account, such as their email, name, company, phone numbers, addresses, custom fields, tags, or list memberships. Optionally include additional properties in the response using the include parameter.

Parámetros de entrada

includestring
Additional properties to include in the response: custom_fields, list_memberships, phone_numbers, street_addresses, notes, sms_channel, taggings. Use comma-separated values for multiple includes.
contact_idstringObligatorio
The unique identifier of the contact to retrieve. This is a UUID string.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get contact activity summary reportCONSTANT_CONTACT_GET_CONTACT_ACTIVITY_SUMMARY_REPORTAcción

GET contact tracking activity summary for a specific contact. Use this action when you need to retrieve email engagement metrics (sends, opens, clicks, bounces, forwards, unsubscribes) for a specific contact across a date range. This is useful for analyzing individual contact engagement patterns and campaign performance at the contact level. This is a read-only operation. Requires the contact_data OAuth scope.

Parámetros de entrada

endstringObligatorio
The ending date for the report, in ISO 8601 format (e.g., 2019-12-01T00:00:00-0500).
startstringObligatorio
The starting date for the report, in ISO 8601 format (e.g., 2019-01-01T00:00:00-0500).
contact_idstringObligatorio
The contact ID for which to retrieve tracking activity data.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Contact ListCONSTANT_CONTACT_GET_CONTACT_LISTAcción

GET details for a specific contact list by its ID. Use this action when you need to retrieve information about a specific contact list in your Constant Contact account, such as its name, description, status, and membership counts.

Parámetros de entrada

list_idstringObligatorio
Unique ID of the contact list to retrieve. This is a UUID string.
include_membership_countstring
Include membership count details. Specify 'active', 'removed', or 'all' to include corresponding counts.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Contact Open and Click Rates ReportCONSTANT_CONTACT_GET_CONTACT_OPEN_AND_CLICK_RATES_REPORTAcción

GET average open and click rates for a contact. Use this action when you need to retrieve the average open rate, click rate, and activity count for a specific contact over a given time period. This is useful for analyzing individual contact engagement with your email campaigns. The response includes the average click rate, average open rate, contact ID, and the number of email activities included in the calculation.

Parámetros de entrada

endstringObligatorio
The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500.
startstringObligatorio
The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500.
contact_idstringObligatorio
The contact ID for which to get tracking activity data. This is a UUID string.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Contacts Export FileCONSTANT_CONTACT_GET_CONTACTS_EXPORT_FILEAcción

Retrieve the exported contacts file from a completed export contacts activity. Use when you need to download the CSV file containing the contacts that were exported using the export contacts feature. The file_export_id is obtained from the results section of the export contacts activity response.

Parámetros de entrada

file_export_idstringObligatorio
The unique ID of the exported file provided in the results section of the export contacts activity response.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Contact SMS Engagement HistoryCONSTANT_CONTACT_GET_CONTACT_SMS_ENGAGEMENT_HISTORYAcción

GET SMS Engagement History for a Contact. Use this action when you need to retrieve the SMS engagement history for a specific contact in Constant Contact. This returns details about SMS consent actions (opt-in, opt-out) and the methods used to add or update SMS contact details. The response contains an array of SMS channel history records with details about consent actions, timestamps, and source information depending on the type of SMS consent granted.

Parámetros de entrada

contact_idstringObligatorio
The contact's unique ID (UUID format).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get contact tag detailsCONSTANT_CONTACT_GET_CONTACT_TAGAcción

GET Tag Details - Retrieves detailed information about a specific contact tag. Use this action when you need to fetch the name, source, creation/update timestamps, and optionally the count of contacts associated with a specific tag in Constant Contact.

Parámetros de entrada

tag_idstringObligatorio
The ID that uniquely identifies a tag (UUID format).
include_countboolean
Use to include (true) or exclude (false) the total number of tagged contacts (contacts_count) from the results.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get custom fieldCONSTANT_CONTACT_GET_CUSTOM_FIELDAcción

GET a custom field by its unique ID. Use this action when you need to retrieve details of a specific custom field from your Constant Contact account, such as its label, type, choices, or metadata configuration.

Parámetros de entrada

custom_field_idstringObligatorio
The ID that uniquely identifies the custom field.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get email campaign detailsCONSTANT_CONTACT_GET_EMAIL_CAMPAIGNAcción

GET details for a single email campaign using its campaign ID. Use this action when you need to retrieve detailed information about a specific email campaign, including its name, subject line, status, content, sender information, and scheduling details. This action is read-only and does not modify any campaign data.

Parámetros de entrada

campaign_idstringObligatorio
The unique ID of the email campaign to retrieve.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Email Campaign ActivityCONSTANT_CONTACT_GET_EMAIL_CAMPAIGN_ACTIVITYAcción

GET details for a specific email campaign activity by its ID. Use this action when you need to retrieve information about a specific email campaign activity in your Constant Contact account, such as its current status, content, or configuration details.

Parámetros de entrada

includestring[]
Use the include query parameter to enter a comma separated list of additional email campaign activity properties for the V3 API to return. Valid values are physical_address_in_footer, permalink_url, html_content, and document_properties.
campaign_activity_idstringObligatorio
The unique ID for an email campaign activity.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get email campaign activity previewCONSTANT_CONTACT_GET_EMAIL_CAMPAIGN_ACTIVITY_PREVIEWAcción

GET the HTML Preview of an Email Campaign Activity. Use this action when you need to retrieve the HTML and plain text preview of an email campaign activity, including subject line, from address, preheader text, and content. This is useful for reviewing how an email will appear before sending it.

Parámetros de entrada

campaign_activity_idstringObligatorio
The unique ID for an email campaign activity.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Email Campaign Activity ScheduleCONSTANT_CONTACT_GET_EMAIL_CAMPAIGN_ACTIVITY_SCHEDULEAcción

GET an email campaign activity schedule. Use this action when you need to retrieve the scheduled date(s) for a specific email campaign activity in Constant Contact. This returns all scheduled send times for the campaign, which can be used to verify when emails will be sent to contacts. This action is read-only and does not modify any campaign data.

Parámetros de entrada

campaign_activity_idstringObligatorio
The unique ID for an email campaign activity.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get email campaign activity send historyCONSTANT_CONTACT_GET_EMAIL_CAMPAIGN_ACTIVITY_SEND_HISTORYAcción

GET the send history of an email campaign activity. Use this action when you need to retrieve the send history records for an email campaign activity in Constant Contact. This returns details about each time the email was sent, including the send date, contact count, recipient lists/segments, and send status. This is a read-only operation suitable for auditing email sends, tracking delivery status, or analyzing campaign performance over multiple sends.

Parámetros de entrada

campaign_activity_idstringObligatorio
The unique ID for an email campaign activity. You can return the send history for primary_email and resend role email campaign activities.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get email campaign ID cross-referencesCONSTANT_CONTACT_GET_EMAIL_CAMPAIGN_ID_XREFSAcción

GET a collection of V2 and V3 API Email Campaign ID cross-references. Use this action when you need to map V2 API campaignId values to V3 API campaign_id and campaign_activity_id values for email campaigns. The endpoint accepts up to 50 V2 campaignId values in each request.

Parámetros de entrada

v2_email_campaign_idsstringObligatorio
Comma separated list of V2 API `campaignId` values. You can enter up to 50 V2 `campaignId` values in each request.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Email Campaign Statistics ReportCONSTANT_CONTACT_GET_EMAIL_CAMPAIGNS_STATS_REPORTAcción

GET statistics for one or more email campaigns. Use this action when you need to retrieve performance statistics for email campaigns, including open rates, click rates, bounce rates, unsubscribe rates, and delivery counts. You can request statistics for multiple campaigns by providing comma-separated campaign IDs. This is a read-only operation that returns aggregated email campaign performance metrics. The response includes both percentage-based and count-based statistics for each campaign.

Parámetros de entrada

campaign_idsstringObligatorio
A comma-separated list of campaign_ids (UUIDs) for which to retrieve statistics. Each campaign ID should be a valid UUID.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get EventCONSTANT_CONTACT_GET_EVENTAcción

GET details for a single event by its unique ID. Use this action when you need to retrieve detailed information about a specific event in your Constant Contact account, such as its name, description, timing, location, organizer, ticket types, registration settings, or other configuration. This is a read-only operation that does not modify any data.

Parámetros de entrada

includeboolean
Use to include (true) or exclude (false) event setting properties in the results. Default is true.
event_idstringObligatorio
The unique ID of the event to retrieve. This is a UUID string.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get list ID cross-referencesCONSTANT_CONTACT_GET_LIST_ID_XREFSAcción

GET a collection of V2 and V3 API List IDs cross-references. Use this action when you need to map V2 API sequence_ids to V3 API list_ids for contact lists. The endpoint accepts up to 500 sequence_ids at a time and returns the corresponding V3 list_id values for each V2 sequence_id.

Parámetros de entrada

sequence_idsstringObligatorio
Comma delimited list of V2 API list `ids` to cross-reference with the V3 API `list_id` value. Endpoint accepts a maximum of 500 ids at a time.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Partner Webhook SubscriptionCONSTANT_CONTACT_GET_PARTNER_WEBHOOK_SUBSCRIPTIONAcción

GET details for a specific Partner Webhook Topic Subscription by its ID. Use this action when you need to retrieve information about a specific webhook topic subscription in your Constant Contact account, such as the webhook callback URI, topic name, description, and topic type.

Parámetros de entrada

topic_idstringObligatorio
Identifies a webhook topic.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get resend to non-openersCONSTANT_CONTACT_GET_RESEND_TO_NON_OPENERSAcción

GET Details for a Resend to Non-openers Campaign Activity. Use this action when you need to retrieve details about a resend to non-openers campaign activity. This includes information about the resend schedule, timing, status, and subject line used for the campaign. This action requires the campaign_activity_id which can be obtained from the campaign activities endpoint or campaign details endpoint.

Parámetros de entrada

campaign_activity_idstringObligatorio
The unique ID for the primary email campaign activity.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get SegmentCONSTANT_CONTACT_GET_SEGMENTAcción

GET details for a specific segment by its unique ID. Use this action when you need to retrieve detailed information about a specific segment in your Constant Contact account, such as its name, segment criteria, and creation/update timestamps. This is a read-only operation that does not modify any data.

Parámetros de entrada

segment_idintegerObligatorio
The system-generated unique ID that identifies a segment.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Import contacts from CSV fileCONSTANT_CONTACT_IMPORT_CONTACTS_FROM_FILEAcción

Import contacts into Constant Contact from a CSV file. Use this action when you need to bulk import contacts from a CSV file into Constant Contact contact lists. The CSV file must include either an 'email' or 'sms_number' column. Supports custom fields with 'cf:' prefix. The activity is processed asynchronously - poll the activity status endpoint to check completion. Note: The base_url should not include /v3 as it's appended in the endpoint path_template.

Parámetros de entrada

list_idsstring[]Obligatorio
List of contact list IDs to add imported contacts to. Array of up to 50 UUID values.
file_to_importanyObligatorio
The CSV file to import. Can be either a FileUploadable object (with name, mimetype, s3key) or inline file data (with content_base64 and name). The CSV must include either 'email' or 'sms_number' as a column heading. Other supported columns: first_name, last_name, phone, job_title, anniversary, birthday_day, birthday_month, company_name, street, street2, city, state, zip, country, sms_consent_date. Custom fields can use 'cf:' prefix.
sms_permission_to_sendstring
How SMS consent was provided for contacts with sms_number. Use 'explicit' if contacts provided consent and include sms_consent_date column. Use 'not_set' if consent not yet provided. Only required when importing contacts with sms_number.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Import contacts from JSONCONSTANT_CONTACT_IMPORT_CONTACTS_FROM_JSONAcción

Bulk import contacts into Constant Contact using JSON format. Use this action when you need to add multiple contacts at once by providing contact data in JSON format. Each contact must have either an email_address or phone_number. Optionally, you can specify list_ids to add contacts to specific contact lists during import. The contacts are processed asynchronously and the response returns an activity_id to track the import progress.

Parámetros de entrada

list_idsstring[]
Array of list IDs to add the imported contacts to. Optional.
import_dataobject[]Obligatorio
Array of contact objects to import. Each contact must have either an email_address or phone_number.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List account email addressesCONSTANT_CONTACT_LIST_ACCOUNT_EMAIL_ADDRESSESAcción

GET a Collection of Account Email Addresses. Use this action when you need to retrieve all email addresses associated with a Constant Contact account. Supports filtering by confirmation status (CONFIRMED/UNCONFIRMED), role code (CONTACT/BILLING/REPLY_TO/JOURNALING/OTHER), or a specific email address. This is a read-only operation that requires the 'account_read' OAuth scope.

Parámetros de entrada

role_codestringenum
Email role codes for account email addresses.
CONTACTCBILLINGBJOURNALINGJREPLY_TOROTHERO
email_addressstring
Use the email_address query parameter to search for a specific account email address.
confirm_statusstringenum
Email confirmation status values.
CONFIRMEDCUNCONFIRMEDU

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List account user privilegesCONSTANT_CONTACT_LIST_ACCOUNT_USER_PRIVILEGESAcción

Get the user privileges associated with your access token. Use this action when you need to determine what permissions the authenticated user has within the Constant Contact API. This is a read-only operation that retrieves privileges without requiring any parameters.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List activity statusesCONSTANT_CONTACT_LIST_ACTIVITY_STATUSESAcción

GET a collection of bulk activities. Use this action when you need to retrieve all bulk activities or filter by status (processing, completed, cancelled, failed, or timed_out). This is useful for monitoring batch operations like contact imports, file exports, or list membership changes.

Parámetros de entrada

limitinteger
Number of results per page (1-500, default 25).
statestringenum
Possible states for a bulk activity.
processingcompletedcancelledfailedtimed_out

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Contact ListsCONSTANT_CONTACT_LIST_CONTACT_LISTSAcción

GET all contact lists for the Constant Contact account. Use this action when you need to retrieve all contact lists from a Constant Contact account. You can filter by name or status, and optionally include membership counts for each list. Results are paginated and can be limited using the limit parameter. This is a read-only operation that returns metadata about contact lists such as names, statuses, and membership information.

Parámetros de entrada

namestring
Filter contact lists by name. Returns exact matches only.
limitinteger
Number of contact lists to return per page. Valid range: 1-500.
statusstring
Filter contact lists by status. Valid values: 'active' or 'deleted'.
include_countboolean
Include membership count for each list. When true, the response includes membership_count for each contact list.
include_membership_countstring
Include membership counts. Valid values: 'active', 'removed', or 'all'. Used with include_count=true.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List contactsCONSTANT_CONTACT_LIST_CONTACTSAcción

GET Contacts Collection to retrieve a list of contacts from Constant Contact. Use this action when you need to fetch contacts from your Constant Contact account, with optional filtering by status, email, lists, segments, tags, or update date. Returns up to 500 contacts at a time with pagination support. This is a read-only operation suitable for retrieving contact collections for analysis, synchronization, or display purposes.

Parámetros de entrada

tagsstring
Filter contacts by tag IDs. Use comma-separated tag IDs for multiple tags.
emailstring
Filter contacts by email address.
limitinteger
Number of contacts to return per page (1-500, default 25).
listsstring
Filter contacts by list membership. Use comma-separated list IDs for multiple lists.
statusstring
Filter contacts by status: active, deleted, not_set, pending_confirmation, temp_hold, or unsubscribed.
includestring
Additional properties to include in the response: custom_fields, list_memberships, phone_numbers, street_addresses, notes, sms_channel, taggings. Use comma-separated values for multiple includes.
segment_idstring
Filter contacts by segment ID.
include_countboolean
Include total count of contacts in the response.
updated_afterstring
Filter contacts updated on or after a specific date (ISO-8601 format).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List contact tagsCONSTANT_CONTACT_LIST_CONTACT_TAGSAcción

GET Details for All Tags - Retrieves all contact tags for the account. Use this action when you need to fetch a list of all tags available in your Constant Contact account. You can optionally include the count of contacts associated with each tag by setting include_count to true. This is a read-only operation that returns tag metadata such as names, sources, and timestamps.

Parámetros de entrada

limitinteger
Number of tags to return (1-500). Defaults to 25.
include_countboolean
Include the total contact count for each tag in the response.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List contact custom fieldsCONSTANT_CONTACT_LIST_CUSTOM_FIELDSAcción

GET custom_fields Collection to retrieve all contact custom field definitions. Use this action when you need to fetch the available custom field definitions that can be used for contacts in Constant Contact. This is a read-only operation that returns metadata about custom fields such as labels, types, and available choices.

Parámetros de entrada

limitinteger
Specifies the number of results displayed per page of output, from 1 - 100, default = 50.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Email CampaignsCONSTANT_CONTACT_LIST_EMAIL_CAMPAIGNSAcción

GET a collection of email campaigns from Constant Contact. Use this action when you need to retrieve email campaigns from your Constant Contact account. You can filter results by creation date using before_date and after_date parameters, and control the number of results using the limit parameter. Results are paginated with optional cursor-based pagination via the next link. This is a read-only operation that returns campaign metadata including names, statuses, creation dates, and activity information. Note: The limit parameter defaults to 25 and must be between 1 and 500.

Parámetros de entrada

limitinteger
Number of email campaigns to return (1-500).
after_datestring
Filter for campaigns created after this date (ISO 8601 format, e.g., 2024-01-01T00:00:00Z).
before_datestring
Filter for campaigns created before this date (ISO 8601 format, e.g., 2024-01-15T00:00:00Z).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Email Campaign Summaries ReportCONSTANT_CONTACT_LIST_EMAIL_CAMPAIGN_SUMMARIES_REPORTAcción

GET an Email Campaigns Summary Report from Constant Contact. Use this action when you need to retrieve an aggregated summary report of all bulk email campaigns, including unique counts for bounces, clicks, opens, sent, unsubscribes, and forwards, as well as aggregated percentage rates for the campaigns on the current page. This is a read-only operation useful for analyzing overall email campaign performance and generating executive-level reports. Note: The limit parameter defaults to 25 and must be between 1 and 500. Pagination is supported via the next link in the response.

Parámetros de entrada

limitinteger
The number of email campaign summaries to return on a single page (1-500, default 25).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Email Did Not Opens ReportCONSTANT_CONTACT_LIST_EMAIL_DID_NOT_OPENS_REPORTAcción

GET an Email Did Not Opens Report to retrieve a list of contacts who did not open a specific email campaign. Use this action when you need to analyze email engagement by identifying contacts that received but did not open a specific email campaign activity. This is useful for re-engagement campaigns, follow-up emails, or engagement analysis. This is a read-only operation that retrieves tracking data without modifying any data.

Parámetros de entrada

limitinteger
The number of tracking activities to return on a page (1-500, default 25).
campaign_activity_idstringObligatorio
The ID that uniquely identifies the email campaign activity to use for this report. This is a UUID string.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List email forwards reportCONSTANT_CONTACT_LIST_EMAIL_FORWARDS_REPORTAcción

GET an Email Forwards Report for a specific email campaign activity. Use this action when you need to retrieve tracking data about email forwards for a specific email campaign activity in Constant Contact. This returns a list of contacts who forwarded the email, including their contact details and the timestamp of the forward. This is a read-only operation suitable for analyzing email campaign engagement through forwards.

Parámetros de entrada

limitinteger
The number of tracking activities to return on a page (1-500, default 25).
campaign_activity_idstringObligatorio
The unique identifier of the email campaign activity to retrieve forwards tracking data for.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List email opt-outs reportCONSTANT_CONTACT_LIST_EMAIL_OPTOUTS_REPORTAcción

GET an Email Opt-outs Report for a specific email campaign activity. Use this action when you need to retrieve a list of contacts who have opted out of a specific email campaign. This provides detailed tracking information including contact identifiers, email addresses, opt-out timestamps, and reason for opting out. This is a read-only operation suitable for generating reports, analyzing campaign performance, or syncing opt-out data with external systems. Note: The campaign_activity_id should be the UUID of an email campaign activity, not the campaign itself.

Parámetros de entrada

limitinteger
The number of tracking activities to return on a page (1-500, default 25).
campaign_activity_idstringObligatorio
The ID that uniquely identifies the email campaign activity to use for this report.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Email Unique Opens ReportCONSTANT_CONTACT_LIST_EMAIL_UNIQUE_OPENS_REPORTAcción

GET an email unique opens report for a campaign activity. Use this action when you need to retrieve a list of contacts who uniquely opened a specific email campaign activity. This is useful for analyzing email engagement, understanding which contacts opened your emails, and tracking campaign performance. The report includes contact details such as email address, name, device type, and the timestamp of each unique open event. Note: This is a read-only operation that retrieves tracking data.

Parámetros de entrada

limitinteger
The number of tracking activities to return on a page. Default is 500 if not specified.
campaign_activity_idstringObligatorio
The ID that uniquely identifies the email campaign activity to use for this report.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List EventsCONSTANT_CONTACT_LIST_EVENTSAcción

GET a collection of events from Constant Contact. Use this action when you need to retrieve events from your Constant Contact account, with optional filtering by status. Results are paginated using cursor-based pagination. This is a read-only operation suitable for retrieving event collections for management, synchronization, or display purposes.

Parámetros de entrada

limitinteger
Number of events to return per page (1-100, default 25).
statusstring
Filter events by status. Valid values: DRAFT, ACTIVE, CANCELLED, or CLOSED.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List event track registrationsCONSTANT_CONTACT_LIST_EVENT_TRACK_REGISTRATIONSAcción

GET registrations for an event track to retrieve a list of registrations. Use this action when you need to fetch registrations for a specific event track in your Constant Contact account, with optional filtering by registration status, payment status, or search text. Supports pagination using cursors and allows sorting by various fields. This is a read-only operation suitable for retrieving registration collections for reporting, analytics, or event management purposes.

Parámetros de entrada

nextstring
Cursor for pagination used to get the next page of results. Mutually exclusive with prev.
prevstring
Cursor for pagination used to get the previous page of results. Mutually exclusive with next.
limitinteger
Limit the number of results returned per page (1-500, default 25). If specifying both limit and page_size, they must be the same value.
sort_bystringenum
Sort by field options for registration results.
first_namelast_nameemail_addressregistration_statuspayment_statusticketstotal
event_idstringObligatorio
The unique identifier of the event. This is a UUID string.
track_idstringObligatorio
The unique identifier of the event track. This is a short string key.
page_sizeinteger
Alternative to limit parameter to limit the number of results returned per page. If specifying both limit and page_size, they must be the same value.
sort_orderstringenum
Sort order direction.
ASCDESC
search_textstring
Filter registration results by first name, last name, or email address.
payment_statusstringenum
Payment status filter values.
PENDINGPAIDREFUNDEDCANCELLEDFAILEDCHARGED_BACK
registration_statusstringenum
Registration status filter values.
PENDINGREGISTEREDCANCELEDEXPIREDIN_PROGRESSFAILED

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Landing Page Contact Opens ReportCONSTANT_CONTACT_LIST_LANDING_PAGE_CONTACT_OPENS_REPORTAcción

GET a Contacts Opens Landing Page Report. Use this action when you need to retrieve a list of contacts who opened a specific landing page campaign. This is useful for analyzing engagement with your landing pages and understanding which contacts have shown interest by opening your content. The response includes tracking activities with contact details, device type, timestamps, and optional SMS channel information. Results can be filtered by contact attributes and paginated using the limit parameter.

Parámetros de entrada

limitinteger
Number of contact tracking activities to return per page (1-500, default 50).
contacts_filterstring
Filter to return only contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields.
campaign_activity_idstringObligatorio
The landing page campaign_activity_id (UUID) to use to get unique contact open results.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Landing Page Unique Contact Adds ReportCONSTANT_CONTACT_LIST_LANDING_PAGE_UNIQUE_CONTACT_ADDS_REPORTAcción

GET a Unique Contacts Adds Landing Page Report for a specific landing page campaign activity. Use this action when you need to retrieve a list of contacts that were added through a landing page campaign. This report shows which contacts signed up via the landing page and includes their contact details along with timing information. This is useful for analyzing landing page conversion performance and contact acquisition. The results are paginated with a default limit of 50 items per page (maximum 500). Use the contacts_filter parameter to search for specific contacts by name or email.

Parámetros de entrada

limitinteger
Use to limit the number of contact tracking activities to return on a single page. The default is 50 and the maximum is 500 per page.
contacts_filterstring
Use to filter the results to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields. For example: Josie or Jo.
campaign_activity_idstringObligatorio
The landing page campaign_activity_id (UUID) to use to get unique contact results.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Landing Page Unique Contact Clicks ReportCONSTANT_CONTACT_LIST_LANDING_PAGE_UNIQUE_CONTACT_CLICKS_REPORTAcción

GET unique contact clicks data for a landing page campaign. Use this action when you need to retrieve detailed click tracking data for contacts who clicked on links in a landing page campaign. This includes contact information (name, email), click timestamps, device type, and the specific URLs clicked. The results are paginated and can be filtered by contact name or email.

Parámetros de entrada

limitinteger
Use to limit the number of contact tracking activities to return on a single page. The default is 50 and the maximum is 500 per page.
contacts_filterstring
Use to filter the results to return only contacts that match a contacts full or partial first or last name, or email. For example: Josie or Jo.
campaign_activity_idstringObligatorio
The landing page `campaign_activity_id` (UUID) to use to get unique contact click results.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Landing Page Unique Contact Opens ReportCONSTANT_CONTACT_LIST_LANDING_PAGE_UNIQUE_CONTACT_OPENS_REPORTAcción

GET a Unique Contacts Opens Landing Page Report to retrieve a list of contacts who uniquely opened a specific landing page campaign. Use this action when you need to analyze landing page engagement by identifying contacts that opened a specific landing page campaign activity. This is useful for engagement analysis, follow-up actions, or campaign performance evaluation. This is a read-only operation that retrieves tracking data without modifying any data.

Parámetros de entrada

limitinteger
The number of contact tracking activities to return on a single page (1-500, default 25).
contacts_filterstring
Filter to only include contacts that contain a certain value. This parameter does full and partial matches and applies to the contact first name, last name, and email fields.
campaign_activity_idstringObligatorio
The landing page campaign_activity_id (UUID) to use to get unique contact open results.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List landing page unique contact updates reportCONSTANT_CONTACT_LIST_LANDING_PAGE_UNIQUE_CONTACT_UPDATES_REPORTAcción

GET a Unique Contacts Updates Landing Page Report for a specific landing page campaign activity. Use this action when you need to retrieve tracking data about contacts who made profile updates after visiting a landing page. This returns a list of contacts who updated their information, including their contact details and the timestamp of the update. This is a read-only operation suitable for analyzing landing page engagement and contact data quality. Note: The campaign_activity_id should be the UUID of a landing page campaign activity.

Parámetros de entrada

limitinteger
The number of contact tracking activities to return on a single page (1-500, default 25).
contacts_filterstring
Filter to return only contacts that contain a certain value in their first name, last name, or email fields. Supports full and partial matches. For example: 'Josie' or 'Jo'.
campaign_activity_idstringObligatorio
The unique identifier of the landing page campaign activity (UUID) to retrieve unique contact updates for.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List SegmentsCONSTANT_CONTACT_LIST_SEGMENTSAcción

GET all segments for the Constant Contact account. Use this action when you need to retrieve all segments from a Constant Contact account. Segments are used to target a subset of contacts based on criteria such as demographics, behavior, or custom conditions. Results are paginated and can be sorted by date, name, or segment ID. This is a read-only operation that returns metadata about segments such as names, statuses, and timestamps for creation and updates.

Parámetros de entrada

limitinteger
Number of segments to return per page. Valid range: 1-1000.
sort_bystring
Sort segments by field. Valid values: date, name, or segment_id.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List SMS Campaign Summaries ReportCONSTANT_CONTACT_LIST_SMS_CAMPAIGN_SUMMARIES_REPORTAcción

GET an SMS Campaigns Summary Report. Use this action when you need to retrieve summary statistics and performance metrics for SMS campaigns. This is useful for analyzing overall SMS campaign performance, including delivery rates, click rates, bounce rates, and unsubscribe rates across multiple campaigns within a specified date range. Note: This is a read-only operation that retrieves aggregated campaign data.

Parámetros de entrada

limitinteger
Use to limit the number of results to return on a single page (from 1 to 50). The default setting is 50.
end_atstring
Use to limit the results to include SMS campaign summary details for SMS campaigns sent on or before the end_at date you specify. ISO 8601 format.
start_atstringObligatorio
Use to limit the results to include SMS campaign summary details for SMS campaigns sent on or after the required start_at date you specify. ISO 8601 format.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Social ConnectionsCONSTANT_CONTACT_LIST_SOCIAL_CONNECTIONSAcción

GET social network connections for a Constant Contact account. Use this action when you need to retrieve all social network accounts (such as Facebook, Instagram, LinkedIn, or TikTok) that are connected to the Constant Contact account. This is a read-only operation that returns information about each connection including account details and connection status. The response includes a list of connections, each containing account information (display name, username, profile URL) and connection status (active, disconnected, error, rate_limited).

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Social Hashtag GroupsCONSTANT_CONTACT_LIST_SOCIAL_HASHTAG_GROUPSAcción

GET hashtag groups - Retrieves a paginated list of social hashtag groups. Use this action when you need to fetch all hashtag groups available in your Constant Contact account. Hashtag groups are named collections of hashtags that can be reused when creating social posts. Results are paginated with a maximum page size of 5 groups per request. This is a read-only operation that returns hashtag group metadata such as names, IDs, and the list of hashtags contained in each group.

Parámetros de entrada

pageinteger
Page number to retrieve (0-based).
limitinteger
Maximum number of hashtag groups to retrieve per page. Default and maximum is 5.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Social ProfilesCONSTANT_CONTACT_LIST_SOCIAL_PROFILESAcción

GET social media profiles from Constant Contact. Use this action when you need to retrieve all social media profiles (such as Facebook Business Pages, Instagram profiles, Twitter accounts, LinkedIn pages, or TikTok accounts) connected to a Constant Contact account. This is a read-only operation that returns profile information including connection status, handles, URLs, and optional accessibility status. Note: Due to performance and/or rate-limit issues, some properties may be cached. Where possible, caching will be limited to 15 minutes.

Parámetros de entrada

includestring[]
Optional sub-resources to include. Use 'accessible' to check if profiles are accessible on the network.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Contact TaggingCONSTANT_CONTACT_REMOVE_CONTACT_TAGGINGAcción

Remove tagging from contacts in Constant Contact. Use this action when you need to asynchronously remove tagging from contacts identified by specific contact IDs, list IDs, tag IDs, all active contacts, or new subscribers. The removal is processed as an asynchronous activity - check the activity status to monitor progress.

Parámetros de entrada

sourceobjectObligatorio
Select the source used to identify contacts from which tags will be removed. Source types are mutually exclusive.
excludeobject
Configuration to exclude specific contacts from the tag removal.
tag_idsstring[]Obligatorio
An array of tag IDs to remove from contacts meeting the specified source criteria. Maximum 50 tags.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Tags from ContactsCONSTANT_CONTACT_REMOVE_CONTACT_TAGGINGSAcción

Remove tags from contacts in Constant Contact. Use this action when you need to asynchronously remove one or more tags from contacts identified by specific contact IDs, list IDs, all active contacts, or new subscribers. The removal is processed as an asynchronous activity - check the activity status to monitor progress.

Parámetros de entrada

sourceobjectObligatorio
Select the source used to identify contacts from which tags will be removed. Source types are mutually exclusive.
excludeobject
Configuration to exclude specific contacts from the tag removal.
tag_idsstring[]Obligatorio
An array of tag IDs to remove from contacts meeting the specified source criteria.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove contacts from listsCONSTANT_CONTACT_REMOVE_LIST_MEMBERSHIPSAcción

Create a Remove Contacts from Lists activity to remove contacts from one or more lists. Use this action when you need to bulk-remove contacts from Constant Contact lists. The activity is queued for asynchronous processing and returns an activity_id that can be used to track the status of the operation.

Parámetros de entrada

sourceobjectObligatorio
Specifies the contacts to remove from target list(s) using mutually exclusive properties.
excludeobject
Optional contact IDs to exclude from removal.
list_idsstring[]Obligatorio
Specify up to 50 target list_id values from which to remove contacts.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rename Email CampaignCONSTANT_CONTACT_RENAME_EMAIL_CAMPAIGNAcción

PATCH (Update) the name of an existing email campaign in Constant Contact. Use this action when you need to rename an existing email campaign. You must provide the campaign ID of the email campaign you want to rename and the new name for the campaign. The campaign name must be unique within your account. Note: This action only updates the campaign name. Other campaign properties remain unchanged. Attempting to use a duplicate name will result in a 409 Conflict error.

Parámetros de entrada

namestringObligatorio
The new name for the email campaign. The name must be unique within your account. Maximum 80 characters.
campaign_idstringObligatorio
The unique identifier for the email campaign to rename (UUID format).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rename SegmentCONSTANT_CONTACT_RENAME_SEGMENTAcción

PATCH (rename) an existing segment in Constant Contact. Use this action when you need to rename an existing segment. You must provide the segment ID of the segment you want to rename and the new name for the segment. The segment name must be unique within your account. Note: This action only updates the segment name. Other segment properties (such as segment_criteria) remain unchanged. Attempting to use a duplicate name will result in a 409 Conflict error.

Parámetros de entrada

namestringObligatorio
The new name for the segment. The name must be unique within your account.
segment_idintegerObligatorio
The system generated ID that uniquely identifies the segment that you want to rename.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Resubscribe ContactCONSTANT_CONTACT_RESUBSCRIBE_CONTACTAcción

Resubscribe an unsubscribed contact to one or more contact lists. Use this action when you need to reactivate a contact that was previously unsubscribed and add them back to specific contact lists. The contact's status will be changed from 'unsubscribed' to 'active', and they will be added to the specified lists. This action is useful for managing contact re-engagement campaigns or when a contact requests to be resubscribed after previously opting out.

Parámetros de entrada

list_idsstring[]Obligatorio
Array of contact list ID values. Constant Contact adds the resubscribed contact to the contact lists you provide in the array.
contact_idstringObligatorio
The ID that uniquely identifies the contact to resubscribe (UUID format).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Undo Event Ticket Check-InCONSTANT_CONTACT_UNDO_CHECK_IN_EVENT_TICKETSAcción

Undo check-in for event tickets. Use this action when you need to mark previously checked-in event tickets as not checked in. This reverses the check-in operation for the specified order ticket keys. Note: The API returns 204 No Content on success with an empty response body.

Parámetros de entrada

event_idstringObligatorio
The unique identifier of the event, in UUID format.
order_ticket_keysstring[]Obligatorio
Array of order ticket keys to mark as not checked in.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Account DetailsCONSTANT_CONTACT_UPDATE_ACCOUNT_DETAILSAcción

PUT (update) Account Details for the authenticated user. Use this action when you need to update the account details such as the account owner's contact information, organization name, or address. This action allows modification of all editable account properties. Changes to read-only fields are ignored by the API.

Parámetros de entrada

websitestring
The organization's website URL.
last_namestring
The account owner's last name.
first_namestring
The account owner's first name.
state_codestring
The two-letter ISO 3166-1 code used to specify the state to associate with the account. This property is required if the country_code is US (United States).
country_codestring
The two-letter ISO 3166-1 code representing the organization's country.
time_zone_idstring
The time zone to use for the account; as defined in the IANA time-zone database.
contact_emailstring
The confirmed email address that is associated with the account owner.
contact_phonestring
The account owner's contact phone number (up to 25 characters in length).
organization_namestring
The name of the organization that is associated with this account.
organization_phonestring
The phone number of the organization that is associated with this account.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Account Physical AddressCONSTANT_CONTACT_UPDATE_ACCOUNT_PHYSICAL_ADDRESSAcción

PUT (update) the Physical Address for an Account. Use this action when you need to update or set the physical address information for a Constant Contact account. This action sends a PUT request to update the account's physical address with the provided address details. Required fields: address_line1, city, and country_code. For US or CA addresses, include state_code and postal_code. For other countries, use state_name instead of state_code.

Parámetros de entrada

citystringObligatorio
The city where the organization is located.
state_codestring
The two letter ISO 3166-1 code for the organization's state. Only used when country_code is US or CA.
state_namestring
Use if the state is not in the US or Canada. Do not use when country_code is US or CA.
postal_codestring
The postal code (ZIP code) of the organization. Required if country_code is US or CA.
country_codestringObligatorio
The two letter ISO 3166-1 code for the organization's country.
address_line1stringObligatorio
Line 1 of the organization's street address.
address_line2string
Line 2 of the organization's street address.
address_line3string
Line 3 of the organization's street address.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ContactCONSTANT_CONTACT_UPDATE_CONTACTAcción

PUT (update) an existing contact in Constant Contact. Use this action when you need to update an existing contact's information such as name, email address, phone numbers, addresses, or list/tag assignments. The contact ID is required to identify which contact to update. All provided fields will be updated; omitted fields will remain unchanged. This action requires the 'contact_update' OAuth scope.

Parámetros de entrada

tag_idsstring[]
List of tag IDs to apply to the contact.
list_idsstring[]
List of list IDs to add the contact to.
job_titlestring
The contact's job title.
last_namestring
The contact's last name.
contact_idstringObligatorio
The unique ID of the contact to update (UUID format).
first_namestring
The contact's first name.
company_namestring
The contact's company name.
custom_fieldsobject[]
List of custom field key-value pairs. Example: [{'custom_field_id': 'cf1', 'value': 'vip'}]
email_addressobject
Email address object for a contact.
phone_numbersobject[]
List of phone numbers associated with the contact.
update_sourcestring
The source of the update. Values: 'Contact' (manually updated), 'API' (updated via API), 'Import' (bulk import), 'Survey' (from survey).
street_addressesobject[]
List of street addresses associated with the contact.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Contact ListCONSTANT_CONTACT_UPDATE_CONTACT_LISTAcción

PUT (update) an existing contact list in Constant Contact. Use this action when you need to update the name, description, or favorite status of an existing contact list. The list ID is required to identify which list to update. Note: The contact list name must be unique within your account. Attempting to use a duplicate name will result in a 409 Conflict error.

Parámetros de entrada

namestringObligatorio
The name of the contact list (must be unique within the account).
list_idstringObligatorio
The unique ID of the contact list to update (UUID format).
favoriteboolean
A boolean value indicating if the contact list is a favorite.
descriptionstring
An optional description for the contact list.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Contact TagCONSTANT_CONTACT_UPDATE_CONTACT_TAGAcción

PUT (Update) a Tag. Use this action when you need to rename an existing contact tag in Constant Contact. The tag name must be unique within your account.

Parámetros de entrada

namestringObligatorio
The new tag name to use. The tag name must be unique.
tag_idstringObligatorio
The system generated ID used to uniquely identify the tag that you want to rename (UUID format).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Custom FieldCONSTANT_CONTACT_UPDATE_CUSTOM_FIELDAcción

Update an existing contact custom field in Constant Contact. Use this action when you need to modify the label, type, or choices of an existing custom field. Properties omitted in the PUT request are overwritten with null values. This action is idempotent - updating a field with the same data produces the same result.

Parámetros de entrada

typestringObligatorioenum
The data value type the custom field accepts.
stringdatecurrencynumberdatetimephone_numbersingle_selectmulti_select
labelstringObligatorio
The custom field name to display in the UI (free-form text).
choicesobject[]
Array of choices for custom fields of type `single_select` or `multi_select`. Maximum 100 elements for dropdown, 20 for checkbox/radio.
custom_field_idstringObligatorio
The ID that uniquely identifies the custom field to update.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Email Campaign ActivityCONSTANT_CONTACT_UPDATE_EMAIL_CAMPAIGN_ACTIVITYAcción

PUT (Update) an Email Campaign Activity in Constant Contact. Use this action when you need to modify an existing email campaign activity such as updating the email content, subject line, sender information, recipient lists, or schedule. The campaign activity ID is required to identify which activity to update. Note: Only format_type 1 and 5 support custom html_content. Format types 2-4 use the editor-based content and ignore html_content. The physical_address_in_footer is required for CAN-SPAM compliance.

Parámetros de entrada

rolestringenum
Valid role values for an email campaign activity.
primary_emailpermalinkresend
subjectstringObligatorio
The email 'Subject' field for the email campaign activity.
from_namestringObligatorio
The email 'From Name' field for the email campaign activity.
preheaderstring
The email preheader for the email campaign activity. Only format_type 3, 4, and 5 support this property.
from_emailstringObligatorio
The email 'From Email' field for the email campaign activity. Must use a confirmed Constant Contact account email address.
campaign_idstring
Identifies a campaign in the V3 API.
format_typeinteger
Identifies the type of email format (1=legacy custom code, 2=2nd gen editor, 3=3rd gen editor, 4=4th gen editor, 5=custom code V3).
segment_idsinteger[]
The contacts that Constant Contact sends the email campaign activity to as an array of segment_id values. Only format_type 3, 4, and 5 support segments.
template_idstring
Identifies the email layout and design template that the email campaign activity is using as a base.
html_contentstring
The HTML or XHTML content for the email campaign activity. Only format_type 1 and 5 can contain html_content.
permalink_urlstring
The permanent link to a web accessible version of the email campaign content.
current_statusstringenum
Valid status values for an email campaign activity.
DRAFTSCHEDULEDEXECUTINGDONEERRORREMOVED
reply_to_emailstringObligatorio
The email 'Reply To Email' field for the email campaign activity. Must use a confirmed Constant Contact account email address.
contact_list_idsstring[]
The contacts that Constant Contact sends the email campaign activity to as an array of contact list_id values. You cannot use contact lists and segments at the same time.
document_propertiesobject
Optional properties for legacy format type emails (format_type 1 and 2).
campaign_activity_idstringObligatorio
The unique ID for the email campaign activity you are updating.
physical_address_in_footerobject
Physical address details displayed in the email footer.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update EventCONSTANT_CONTACT_UPDATE_EVENTAcción

PATCH (update) an existing event in Constant Contact. Use this action when you need to modify event details such as name, title, description, dates, location, or status. Only include fields that you want to update - other fields remain unchanged. This action returns 204 No Content on success with an empty response body. This action requires the 'campaign_data' OAuth scope.

Parámetros de entrada

namestring
The name of the event (must be unique for the account).
titlestring
The title for the event. The title does not have to be unique for an account.
statusstring
Specifies the event's current status.
addressobject
Address object for event location.
contactobject
Contact object for event organizer.
event_idstringObligatorio
The ID that uniquely identifies the event to update.
event_endstring
The date the event ends (ISO format).
time_zonestring
The time zone where the event takes place.
event_codestring
The short code to use for the event.
event_typestring
Identifies the event type.
descriptionstring
Provides the event description.
event_startstring
The date the event starts (ISO format).
currency_typestring
The accepted currency for payments (e.g., 'USD', 'EUR').
location_typestring
Specifies if the event is physical and/or virtual, or to be determined.
event_metadataobject
Event metadata object.
online_meetingobject
Online meeting details for virtual events.
notify_owner_on_regboolean
If true, sends an email to the event owner when a registration is made.
display_contact_flagboolean
Display or hide event contact information on the registration form and registration confirmation message.
display_end_time_flagboolean
Display or hide the event end time on the registration form and registration confirmation message.
display_time_zone_flagboolean
Display the time zone on the registration form and registration confirmation message.
display_on_calendar_flagboolean
Display the event on the Event Calendar.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Event Track Registration Payment StatusCONSTANT_CONTACT_UPDATE_EVENT_TRACK_REGISTRATION_PAYMENT_STATUSAcción

Update the payment status for event track registrations in Constant Contact. Use this action when you need to update the payment status for one or more registrations of an event track. This is commonly used to mark registrations as paid, pending, refunded, or failed after processing payments. The action requires the event ID, track ID, the new payment status, and a list of registration IDs to update. Note: Some registrations may fail to update while others succeed (207 Multi-Status). Check the response results for details on each registration update outcome.

Parámetros de entrada

event_idstringObligatorio
The ID that uniquely identifies the event (UUID format).
track_idstringObligatorio
The track key that uniquely identifies the event track.
payment_statusstringObligatorio
The new payment status to set. Common values: 'Pending', 'Paid', 'Refunded', 'Failed'.
registration_idsstring[]Obligatorio
List of registration IDs to update with the new payment status.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Event Track RegistrationsCONSTANT_CONTACT_UPDATE_EVENT_TRACK_REGISTRATIONSAcción

PUT (update) registration status for event track registrations. Use this action when you need to update the registration status (APPROVED, CANCELED, or DECLINED) for one or more registrations within an event track in Constant Contact. This action supports batch updates - you can update multiple registrations at once by providing a list of registration IDs. The action also supports optional inventory management via the return_items_to_inventory parameter. This action requires the 'campaign_data' OAuth scope.

Parámetros de entrada

event_idstringObligatorio
The ID that uniquely identifies the event.
track_idstringObligatorio
The track key that uniquely identifies the event track.
increase_countboolean
Override count flag. When set to true, forces the registration count to be incremented.
registration_idsstring[]Obligatorio
List of registration IDs to update.
increase_item_countboolean
Override item count flag. When set to true, forces the item count to be incremented.
registration_statusstringObligatorio
New registration status to set. Valid values: PENDING, REGISTERED, CANCELED, EXPIRED, IN_PROGRESS, FAILED.
return_items_to_inventoryboolean
Return items to inventory flag. Defaults to true. Set to false to keep items consumed.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update SegmentCONSTANT_CONTACT_UPDATE_SEGMENTAcción

PUT (update) an existing segment in Constant Contact. Use this action when you need to update an existing segment's name or contact selection criteria. The segment ID is required to identify which segment to update. Both name and segment_criteria are required in the request body. Note: The segment_criteria must be formatted as single-string escaped JSON, and the top-level group type must be 'and'. Attempting to use duplicate names will result in a 409 Conflict error.

Parámetros de entrada

namestringObligatorio
The segment's unique descriptive name.
segment_idintegerObligatorio
The system generated ID that uniquely identifies the segment that you want to modify.
segment_criteriastringObligatorio
The segment criteria formatted as single-string escaped JSON. Specifies the contact data that Constant Contact uses to identify contacts meeting your criteria. The top-level group type must be 'and'.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not