constantcontact
Module constantcontact
API
Definitions
ballerinax/constantcontact Ballerina library
Overview
Constant Contact is an email marketing platform for small businesses, offering contact management, email campaigns, automation, event management, social posting and reporting.
The Constant Contact connector lets Ballerina applications call version 3 of the Constant Contact API. It covers account services, contacts, contact lists, tags and custom fields, segments, bulk activities, email campaigns and their reports, automations, events, social posts and partner account management.
Key features
- Create, update, import and delete contacts, contact lists, tags and custom fields
- Draft, schedule and send email campaigns, and run A/B tests on campaign activities
- Track campaign performance with email, SMS and landing page reports
- Manage events, registrations, social posts and automation workflows
- Provision and manage partner client accounts and webhook subscriptions
Setup guide
To use the Constant Contact connector, you need an OAuth 2.0 access token for your Constant Contact account.
-
Sign in to the Constant Contact developer portal with your Constant Contact account.
-
Open My Applications and create a new application.
-
Copy the application's API Key (client ID) and create a client secret.
-
Add a redirect URI for your application and select the scopes it needs, such as
contact_data,campaign_dataandaccount_read. If you configure the connector with a refresh token, also select the optionaloffline_accessscope, which is required for a refresh token to be issued. -
Authorize the application using the OAuth 2.0 authorization code flow against
https://authz.constantcontact.com/oauth2/default/v1/authorize, then exchange the code athttps://authz.constantcontact.com/oauth2/default/v1/token. -
Keep the returned access token, or the refresh token together with the client ID and client secret, to configure the connector.
Quickstart
To use the constantcontact connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the connector.
import ballerinax/constantcontact;
Step 2: Create a Config.toml file with your access token.
accessToken = "<access-token>"
Then declare the matching configurable.
configurable string accessToken = ?;
Step 3: Initialize the client.
final constantcontact:Client constantContactClient = check new ({auth: {token: accessToken}});
Step 4: Invoke an operation.
public function main() returns error? { constantcontact:Activities _ = check constantContactClient->listActivities(); }
Examples
The Constant Contact connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Contact list onboarding - Find or create a contact list, add a contact to it, and read the contact back.
- Email campaign drafting - Draft an email campaign with one email activity and inspect the created campaign.
Clients
constantcontact: Client
The Constant Contact, Inc. V3 public API, for building integrations with Constant Contact, the leading small-business email marketing platform.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.cc.email/v3" - URL of the target service
getUserPrivileges
function getUserPrivileges(map<string|string[]> headers) returns UserPrivilegesResource|errorGET User Privileges
Return Type
- UserPrivilegesResource|error - The privileges granted to the user
getAccountSummary
function getAccountSummary(map<string|string[]> headers, *GetAccountSummaryQueries queries) returns Customer|errorGET a Summary of Account Details
Parameters
- queries *GetAccountSummaryQueries - Queries to be sent with the request
updateAccountSummary
function updateAccountSummary(CustomerPut payload, map<string|string[]> headers) returns CustomerPut|errorPUT (update) Account Details
Parameters
- payload CustomerPut - In the request body, specify changes to account details by including and modifying all or select
CustomerPutproperties. Changes to read-only fields (encoded_account_id) are ignored
Return Type
- CustomerPut|error - The updated account details
getPhysicalAddress
function getPhysicalAddress(map<string|string[]> headers) returns AccountPhysicalAddress|errorGET the Physical Address for the Account
Return Type
- AccountPhysicalAddress|error - The physical address for the account
updatePhysicalAddress
function updatePhysicalAddress(AccountPhysicalAddress payload, map<string|string[]> headers) returns AccountPhysicalAddress|errorPUT (update) the Physical Address for an Account
Parameters
- payload AccountPhysicalAddress - Include all
AccountPhysicalAddressproperties required for the specifiedcountry_codeand then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address
Return Type
- AccountPhysicalAddress|error - The updated physical address
createPhysicalAddress
function createPhysicalAddress(AccountPhysicalAddress payload, map<string|string[]> headers) returns AccountPhysicalAddress|errorPOST the Physical Address for the Account
Parameters
- payload AccountPhysicalAddress - Include all
AccountPhysicalAddressproperties required for the specifiedcountry_code. If a required property is not included or incorrectly formatted, a 400 error message is returned. If the address already exists, a 409 error message is returned
Return Type
- AccountPhysicalAddress|error - The created physical address
getCompanyLogo
function getCompanyLogo(map<string|string[]> headers) returns CompanyLogo|error?GET the Company Logo for the Account
Return Type
- CompanyLogo|error? - The company logo for the account
updateCompanyLogo
function updateCompanyLogo(CompanyLogo payload, map<string|string[]> headers) returns CompanyLogo|errorPUT (update) the Company Logo for the Account
Parameters
- payload CompanyLogo - Specify the company logo by including either
internal_idorexternal_url
Return Type
- CompanyLogo|error - The updated company logo
listAccountEmailAddresses
function listAccountEmailAddresses(map<string|string[]> headers, *ListAccountEmailAddressesQueries queries) returns AccountEmails|errorGET a Collection of Account Email Addresses
Parameters
- queries *ListAccountEmailAddressesQueries - Queries to be sent with the request
Return Type
- AccountEmails|error - The account email addresses
createAccountEmailAddress
function createAccountEmailAddress(AccountEmailInput payload, map<string|string[]> headers) returns AccountEmailCreateResponse|errorPOST Add an Account Email Address
Parameters
- payload AccountEmailInput - A JSON request payload containing the new email address you want to add to the Constant Contact account
Return Type
- AccountEmailCreateResponse|error - The added account email address
listActivities
function listActivities(map<string|string[]> headers, *ListActivitiesQueries queries) returns Activities|errorGET Activity Status Collection
Parameters
- queries *ListActivitiesQueries - Queries to be sent with the request
Return Type
- Activities|error - The collection of activity statuses
getActivity
GET an Activity Status
Parameters
- activityId string - The unique ID of the activity to GET
createContactsExport
function createContactsExport(ContactsExport payload, map<string|string[]> headers) returns ActivityExportStatus|errorExport Contacts to a File
Parameters
- payload ContactsExport - A JSON payload that specifies the contacts (rows in the CSV file) and contact properties (columns in the CSV file) you want to export
Return Type
- ActivityExportStatus|error - The contact export activity, queued for processing
getContactsExport
Retrieve Exported Contacts File
Parameters
- fileExportId string - The unique ID of the exported file provided in the results: section of the export contacts activity response
createContactDeleteActivity
function createContactDeleteActivity(ContactDelete payload, map<string|string[]> headers) returns ActivityDeleteStatus|errorDelete Contacts in Bulk
Parameters
- payload ContactDelete - The request body contains an array of contact_ids <em>or</em> list_ids. All contact_ids provided are deleted, or all members of each specified list_id are deleted
Return Type
- ActivityDeleteStatus|error - The bulk contact delete activity, queued for processing
importContactsCsv
function importContactsCsv(ActivitiesContactsFileImportBody payload, map<string|string[]> headers) returns ActivityImport|errorImport Contacts using a CSV File
Parameters
- payload ActivitiesContactsFileImportBody - CSV file and import options for bulk contact import
Return Type
- ActivityImport|error - The CSV contact import activity, queued for processing
importContactsJson
function importContactsJson(ContactsJsonImport payload, map<string|string[]> headers) returns ActivityImport|errorImport Contacts using a JSON Payload
Parameters
- payload ContactsJsonImport - The JSON request payload that contains the contact data and contact lists for the import
Return Type
- ActivityImport|error - The JSON contact import activity, queued for processing
createListRemoveContactsActivity
function createListRemoveContactsActivity(ListActivityRemoveContacts payload, map<string|string[]> headers) returns ActivityListsMembership|errorRemove Contacts from Lists
Parameters
- payload ListActivityRemoveContacts - The JSON payload used to create the Remove Contacts from Lists' activity
Return Type
- ActivityListsMembership|error - The remove-from-lists activity, queued for processing
createListAddContactsActivity
function createListAddContactsActivity(ListActivityAddContacts payload, map<string|string[]> headers) returns ActivityListsMembership|errorAdd Contacts to Lists
Parameters
- payload ListActivityAddContacts - The JSON payload used to create the 'add contacts to lists' activity
Return Type
- ActivityListsMembership|error - The add-to-lists activity, queued for processing
createListDeleteActivity
function createListDeleteActivity(ListIdList100 payload, map<string|string[]> headers) returns ActivityDeleteListsResponse|errorDelete Contact Lists
Parameters
- payload ListIdList100 - An array of
list_id's to delete
Return Type
- ActivityDeleteListsResponse|error - The list delete activity, queued for processing
createTagRemoveContactsActivity
function createTagRemoveContactsActivity(TagAddRemoveContacts payload, map<string|string[]> headers) returns ActivityTagging|errorRemove Tags from Contacts
Parameters
- payload TagAddRemoveContacts - The JSON payload used to create an asynchronous activity that removes tags from contacts meeting your specified contact filtering criteria
Return Type
- ActivityTagging|error - The tag removal activity, queued for processing
createTagAddContactsActivity
function createTagAddContactsActivity(TagAddRemoveContacts payload, map<string|string[]> headers) returns ActivityTagging|errorAdd Tags to Contacts
Parameters
- payload TagAddRemoveContacts - The JSON payload used to create an asynchronous activity that adds tags to contacts that meet your specified contact filtering criteria
Return Type
- ActivityTagging|error - The tagging activity, queued for processing
createTagDeleteActivity
function createTagDeleteActivity(TagIdList500Limit payload, map<string|string[]> headers) returns ActivityTagging|errorDelete Tags
Parameters
- payload TagIdList500Limit - An array of string values (
tag_ids) to delete
Return Type
- ActivityTagging|error - The tag delete activity, queued for processing
createCustomFieldDeleteActivity
function createCustomFieldDeleteActivity(CustomFieldId100 payload, map<string|string[]> headers) returns ActivityDeleteCustomFields|errorDelete Custom Fields
Parameters
- payload CustomFieldId100 - An array of
custom_field_id's to delete
Return Type
- ActivityDeleteCustomFields|error - The custom field delete activity, queued for processing
listEvents
function listEvents(map<string|string[]> headers, *ListEventsQueries queries) returns PaginationDtoEventListingDto|errorGET a collection of events.
Parameters
- queries *ListEventsQueries - Queries to be sent with the request
Return Type
- PaginationDtoEventListingDto|error - A page of events
createDefaultEvent
function createDefaultEvent(map<string|string[]> headers, *CreateDefaultEventQueries queries) returns EventDto|errorPOST (create) a new event.
Parameters
- queries *CreateDefaultEventQueries - Queries to be sent with the request
getEvent
function getEvent(string eventId, map<string|string[]> headers, *GetEventQueries queries) returns EventDto|errorGET details for a single event.
Parameters
- eventId string - The ID that uniquely identifies the event
- queries *GetEventQueries - Queries to be sent with the request
updateEvent
PATCH (update) an event.
Parameters
- eventId string - The ID that uniquely identifies the event to update
- payload EventDto - A JSON request body containing the event fields to update
Return Type
- error? - Event updated successfully
copyEvent
function copyEvent(string eventId, EventCopyRequestDto payload, map<string|string[]> headers) returns EventDto|errorPOST (copy) an existing event.
Parameters
- eventId string - The ID of the event to copy
- payload EventCopyRequestDto - A JSON request body containing the copy options
checkInTickets
function checkInTickets(string eventId, OrderTicketKeysRequestDto payload, map<string|string[]> headers) returns error?Check in event tickets.
Parameters
- eventId string - The ID that uniquely identifies the event
- payload OrderTicketKeysRequestDto - Set of order ticket keys to mark as checked in
Return Type
- error? - Successfully checked in order tickets
undoCheckInTickets
function undoCheckInTickets(string eventId, OrderTicketKeysRequestDto payload, map<string|string[]> headers) returns error?Undo event ticket check-in.
Parameters
- eventId string - The ID that uniquely identifies the event
- payload OrderTicketKeysRequestDto - Set of order ticket keys to mark as not checked in
Return Type
- error? - Successfully undone check-in for order tickets
getEventRegistration
function getEventRegistration(string eventId, string trackId, string registrationId, map<string|string[]> headers) returns DetailedRegistrationDto|errorGet registration details for an event.
Parameters
- eventId string - The ID that uniquely identifies the event
- trackId string - The track key that uniquely identifies the event track
- registrationId string - The ID that uniquely identifies the registration
Return Type
- DetailedRegistrationDto|error - The registration details
listEventRegistrations
function listEventRegistrations(string eventId, string trackId, map<string|string[]> headers, *ListEventRegistrationsQueries queries) returns PaginatedRegistrations|errorGet a list of registrations for an event.
Parameters
- eventId string - The ID that uniquely identifies the event
- trackId string - The track ID that uniquely identifies the event track
- queries *ListEventRegistrationsQueries - Queries to be sent with the request
Return Type
- PaginatedRegistrations|error - Successfully retrieved registrations
updateEventRegistrationStatus
function updateEventRegistrationStatus(string eventId, string trackId, RegistrationStatusUpdateRequestDto payload, map<string|string[]> headers, *UpdateEventRegistrationStatusQueries queries) returns error?Update status for event registrations.
Parameters
- eventId string - The ID that uniquely identifies the event
- trackId string - The track key that uniquely identifies the event track
- payload RegistrationStatusUpdateRequestDto - Registration status update request data
- queries *UpdateEventRegistrationStatusQueries - Queries to be sent with the request
Return Type
- error? - Successfully updated registration status
updateEventRegistrationPaymentStatus
function updateEventRegistrationPaymentStatus(string eventId, string trackId, PaymentStatusUpdateRequestDto payload, map<string|string[]> headers) returns error?Update payment status for event registrations.
Parameters
- eventId string - The ID that uniquely identifies the event
- trackId string - The track key that uniquely identifies the event track
- payload PaymentStatusUpdateRequestDto - Payment status update request data
Return Type
- error? - Successfully updated payment status
listSocialProfiles
function listSocialProfiles(map<string|string[]> headers, *ListSocialProfilesQueries queries) returns Profiles|errorGET social media profiles
Parameters
- queries *ListSocialProfilesQueries - Queries to be sent with the request
listSocialConnections
function listSocialConnections(map<string|string[]> headers) returns ConnectionResponseDto|errorGET social network connections
Return Type
- ConnectionResponseDto|error - The social network connections
listSocialHashtagGroups
function listSocialHashtagGroups(map<string|string[]> headers, *ListSocialHashtagGroupsQueries queries) returns PagedHashtagGroupsDto|errorGET hashtag groups
Parameters
- queries *ListSocialHashtagGroupsQueries - Queries to be sent with the request
Return Type
- PagedHashtagGroupsDto|error - A page of hashtag groups
createSocialPost
function createSocialPost(PostCreateDto payload, map<string|string[]> headers) returns PostDto|errorPOST (create) a social media post
Parameters
- payload PostCreateDto - The social post content and configuration
listSegments
function listSegments(map<string|string[]> headers, *ListSegmentsQueries queries) returns SegmentsDTO|errorGET all Segments
Parameters
- queries *ListSegmentsQueries - Queries to be sent with the request
Return Type
- SegmentsDTO|error - The collection of segments
createSegment
function createSegment(SegmentData payload, map<string|string[]> headers) returns SegmentDetail|errorPOST (create) a Segment
Parameters
- payload SegmentData - The segment
nameandsegment_criteria(requires single-string escaped JSON)
Return Type
- SegmentDetail|error - Segment successfully created
getSegment
GET a Segment's Details
Parameters
- segmentId Signed32 - The system-generated unique ID that identifies a segment
Return Type
- SegmentDetail|error - The segment was successfully returned
updateSegment
function updateSegment(Signed32 segmentId, SegmentData payload, map<string|string[]> headers) returns SegmentDetail|errorPUT (update) a Segment
Parameters
- segmentId Signed32 - The system generated ID that uniquely identifies the segment that you want to modify
- payload SegmentData - Include both the
nameandsegment_criteria(single-string escaped JSON) in the body request, then make updates to either or both
Return Type
- SegmentDetail|error - The segment was successfully updated
deleteSegment
DELETE a Segment
Parameters
- segmentId Signed32 - The system generated ID that uniquely identifies the segment
Return Type
- error? - The segment was successfully deleted
renameSegment
function renameSegment(Signed32 segmentId, SegmentName payload, map<string|string[]> headers) returns SegmentDetail|errorPATCH (rename) a Segment
Parameters
- segmentId Signed32 - The system generated ID that uniquely identifies the segment that you want to modify
- payload SegmentName - Include the existing segment
namein the body request, then rename the segment using a unique new name
Return Type
- SegmentDetail|error - The segment name was successfully updated
getContact
function getContact(string contactId, map<string|string[]> headers, *GetContactQueries queries) returns ContactResource|errorGET a Contact
Parameters
- contactId string - Unique ID of contact to GET
- queries *GetContactQueries - Queries to be sent with the request
Return Type
- ContactResource|error - The requested contact
updateContact
function updateContact(string contactId, ContactPutRequest payload, map<string|string[]> headers) returns ContactResource|errorPUT (update) a Contact
Parameters
- contactId string - Unique ID of contact to update
- payload ContactPutRequest - JSON payload defining the contact object, with updates. Any properties left blank or not included in the PUT payload are overwritten with null value - does not apply to contact subresources
Return Type
- ContactResource|error - Contact resource has been updated
deleteContact
DELETE a Contact
Parameters
- contactId string - Unique ID of contact to DELETE
Return Type
- error? - The contact was deleted; no content is returned
listContacts
function listContacts(map<string|string[]> headers, *ListContactsQueries queries) returns Contacts|errorGET Contacts Collection
Parameters
- queries *ListContactsQueries - Queries to be sent with the request
createContact
function createContact(ContactPostRequest payload, map<string|string[]> headers) returns ContactResource|errorPOST (create) a Contact
Parameters
- payload ContactPostRequest - The JSON payload defining the contact
Return Type
- ContactResource|error - New contact successfully created
createOrUpdateContact
function createOrUpdateContact(ContactCreateOrUpdateInput payload, map<string|string[]> headers) returns ContactCreateOrUpdateResponse|errorCreate or Update a Contact
Parameters
- payload ContactCreateOrUpdateInput - A JSON request body payload that contains the contact resource you are creating or updating. The request body must contain the
email_addressproperty andlist_membershipsarray, or thesms_channelobject
Return Type
- ContactCreateOrUpdateResponse|error - Contact successfully updated
listContactIdXrefs
function listContactIdXrefs(map<string|string[]> headers, *ListContactIdXrefsQueries queries) returns ContactXrefs|errorGET a collection of V2 and V3 API contact IDs
Parameters
- queries *ListContactIdXrefsQueries - Queries to be sent with the request
Return Type
- ContactXrefs|error - The V2 to V3 contact ID cross-references
getCustomField
function getCustomField(string customFieldId, map<string|string[]> headers) returns CustomField|errorGET a custom_field
Parameters
- customFieldId string - The ID that uniquely identifies the custom field
Return Type
- CustomField|error - The requested custom field
updateCustomField
function updateCustomField(string customFieldId, CustomFieldPutRequest payload, map<string|string[]> headers) returns CustomField|errorUpdate a custom field.
Parameters
- customFieldId string - The ID that uniquely identifies the custom field to update
- payload CustomFieldPutRequest - The JSON payload used to update an existing custom field. Any properties omitted in the PUT request are overwritten with a null value
Return Type
- CustomField|error - Success - custom_field updated
deleteCustomField
DELETE a custom_field
Parameters
- customFieldId string - The ID that uniquely identifies the custom field to delete
Return Type
- error? - The custom field was deleted; no content is returned
listCustomFields
function listCustomFields(map<string|string[]> headers, *ListCustomFieldsQueries queries) returns CustomFields|errorGET custom_fields Collection
Parameters
- queries *ListCustomFieldsQueries - Queries to be sent with the request
Return Type
- CustomFields|error - The collection of custom fields
createCustomField
function createCustomField(CustomFieldRequest payload, map<string|string[]> headers) returns CustomField|errorPOST (create) a custom_field
Parameters
- payload CustomFieldRequest - The JSON payload required to create a new custom field
Return Type
- CustomField|error - New custom field successfully created
getList
function getList(string listId, map<string|string[]> headers, *GetListQueries queries) returns ContactList|errorGET a List
Parameters
- listId string - The system generated ID that uniquely identifies a contact list
- queries *GetListQueries - Queries to be sent with the request
Return Type
- ContactList|error - The requested list
updateList
function updateList(string listId, ListInput payload, map<string|string[]> headers) returns ContactListPutPost|errorPUT (update) a List
Parameters
- listId string - Unique ID of the contact list to update
- payload ListInput - JSON payload containing updates to the specified contact list
Return Type
- ContactListPutPost|error - The updated list
deleteList
function deleteList(string listId, map<string|string[]> headers) returns ActivityDeleteListResponse|errorDELETE a List
Parameters
- listId string - Unique ID of the list to delete
Return Type
- ActivityDeleteListResponse|error - Request accepted; the list delete activity status
listLists
function listLists(map<string|string[]> headers, *ListListsQueries queries) returns ContactListArray|errorGET Lists Collection
Parameters
- queries *ListListsQueries - Queries to be sent with the request
Return Type
- ContactListArray|error - The collection of lists
createList
function createList(ListInput payload, map<string|string[]> headers) returns ContactListPutPost|errorPOST (create) a List
Parameters
- payload ListInput - JSON payload defining the new contact list
Return Type
- ContactListPutPost|error - New list successfully created
listListIdXrefs
function listListIdXrefs(map<string|string[]> headers, *ListListIdXrefsQueries queries) returns ListXrefs|errorGET a collection of V2 and V3 API List IDs
Parameters
- queries *ListListIdXrefsQueries - Queries to be sent with the request
getSmsEngagementHistory
function getSmsEngagementHistory(string contactId, map<string|string[]> headers) returns SmsEngagementHistory|errorGET SMS Engagement History for a Contact
Parameters
- contactId string - The contact's unique ID
Return Type
- SmsEngagementHistory|error - The SMS engagement history for the contact
getContactConsentCounts
function getContactConsentCounts(map<string|string[]> headers, *GetContactConsentCountsQueries queries) returns ContactsCounts|errorGET Contact Consent Counts
Parameters
- queries *GetContactConsentCountsQueries - Queries to be sent with the request
Return Type
- ContactsCounts|error - Contact counts by consent state
resubscribeContact
function resubscribeContact(string contactId, ContactResubscribeRequest payload, map<string|string[]> headers) returns error?PUT Resubscribe a Contact
Parameters
- contactId string - The ID that uniquely identifies the contact to resubscribe
- payload ContactResubscribeRequest - The JSON payload used to specify one (or more) contact lists to which the contact requested to be resubscribed
Return Type
- error? - Contact resource has been updated
getTag
function getTag(string tagId, map<string|string[]> headers, *GetTagQueries queries) returns Tag|errorGET Tag Details
Parameters
- tagId string - The ID that uniquely identifies a tag (UUID format)
- queries *GetTagQueries - Queries to be sent with the request
updateTag
PUT (Update) a Tag
Parameters
- tagId string - The system generated ID used to uniquely identify the tag that you want to rename (UUID format)
- payload TagPut - The JSON payload used to update the tag name (
name)
deleteTag
DELETE a Tag
Parameters
- tagId string - The ID that uniquely identifies a tag in UUID format
Return Type
- ActivityGeneric|error - The asynchronous request was successfully accepted. To view the results of the activity request, use the href link returned in the response
listTags
GET Details for All Tags
Parameters
- queries *ListTagsQueries - Queries to be sent with the request
createTag
POST (Create) a Tag
Parameters
- payload TagPost - The JSON payload to use to create a new tag
listEmailCampaigns
function listEmailCampaigns(map<string|string[]> headers, *ListEmailCampaignsQueries queries) returns PagedEmailCampaignResponse|errorGET a Collection of Email Campaigns
Parameters
- queries *ListEmailCampaignsQueries - Queries to be sent with the request
Return Type
- PagedEmailCampaignResponse|error - A page of email campaigns
createEmailCampaign
function createEmailCampaign(EmailCampaignComplete payload, map<string|string[]> headers) returns EmailCampaign|errorPOST (Create) a New Email Campaign
Parameters
- payload EmailCampaignComplete - A JSON request body that contains the email content
Return Type
- EmailCampaign|error - The created email campaign. A campaign created in the legacy (V7) format is converted to the custom code format
getEmailCampaign
function getEmailCampaign(string campaignId, map<string|string[]> headers) returns EmailCampaign|errorGET Details About a Single Email Campaign
Parameters
- campaignId string - The ID (UUID format) that uniquely identifies this email campaign
Return Type
- EmailCampaign|error - The requested email campaign
deleteEmailCampaign
DELETE an Email Campaign
Parameters
- campaignId string - The unique ID for the email campaign you are deleting
Return Type
- error? - Email campaign successfully deleted. No response body returned
renameEmailCampaign
function renameEmailCampaign(string campaignId, EmailCampaignName payload, map<string|string[]> headers) returns EmailCampaign|errorPATCH (Update) an Email Campaign Name
Parameters
- campaignId string - The unique identifier for an email campaign
- payload EmailCampaignName - A JSON payload that contains the new email campaign name
Return Type
- EmailCampaign|error - The renamed email campaign
listEmailCampaignIdXrefs
function listEmailCampaignIdXrefs(map<string|string[]> headers, *ListEmailCampaignIdXrefsQueries queries) returns CrossReferenceResponse|errorGET a Collection of V2 and V3 API Email Campaign Identifiers
Parameters
- queries *ListEmailCampaignIdXrefsQueries - Queries to be sent with the request
Return Type
- CrossReferenceResponse|error - The V2 to V3 email campaign ID cross-references
getEmailCampaignActivity
function getEmailCampaignActivity(string campaignActivityId, map<string|string[]> headers, *GetEmailCampaignActivityQueries queries) returns EmailCampaignActivity|errorGET a Single Email Campaign Activity
Parameters
- campaignActivityId string - The unique ID for an email campaign activity
- queries *GetEmailCampaignActivityQueries - Queries to be sent with the request
Return Type
- EmailCampaignActivity|error - The requested email campaign activity
updateEmailCampaignActivity
function updateEmailCampaignActivity(string campaignActivityId, EmailCampaignActivity payload, map<string|string[]> headers) returns EmailCampaignActivity|errorPUT (Update) An Email Campaign Activity
Parameters
- campaignActivityId string - The unique ID for the email campaign activity you are updating
- payload EmailCampaignActivity - A request body payload that contains the complete email campaign activity with your changes
Return Type
- EmailCampaignActivity|error - Email campaign activity successfully updated
listEmailSchedules
function listEmailSchedules(string campaignActivityId, map<string|string[]> headers) returns EmailScheduleResponse|errorGET an Email Campaign Activity Schedule
Parameters
- campaignActivityId string - The unique ID for an email campaign activity
Return Type
- EmailScheduleResponse|error - The schedule for the email campaign activity
createEmailSchedule
function createEmailSchedule(string campaignActivityId, EmailScheduleInput payload, map<string|string[]> headers) returns EmailScheduleResponse|errorPOST (Create) an Email Campaign Activity Schedule
Parameters
- campaignActivityId string - The unique ID for an email campaign activity. You can only schedule email campaign activities that have the
primary_emailrole
- payload EmailScheduleInput - A request body payload that contains the date that you want Constant Contact to send your email campaign activity on. Use
"0"as the date to have Constant Contact immediately send the email campaign activity
Return Type
- EmailScheduleResponse|error - The created schedule
deleteEmailSchedules
function deleteEmailSchedules(string campaignActivityId, map<string|string[]> headers) returns error?DELETE an Email Campaign Activity Schedule
Parameters
- campaignActivityId string - The unique ID for an email campaign activity
Return Type
- error? - Email campaign activity schedule successfully deleted. No response body returned
createEmailTestSend
function createEmailTestSend(string campaignActivityId, EmailTestSendInput payload, map<string|string[]> headers) returns error?POST Test Send an Email Campaign Activity
Parameters
- campaignActivityId string - The unique ID for an email campaign activity. You can only test send email campaign activities that have the
primary_emailrole
- payload EmailTestSendInput - A JSON request body that contains the recipients of the test email and an optional personal message
Return Type
- error? - Test email campaign activity successfully sent. No response body returned
getEmailCampaignActivityPreview
function getEmailCampaignActivityPreview(string campaignActivityId, map<string|string[]> headers) returns EmailCampaignActivityPreview|errorGET the HTML Preview of an Email Campaign Activity
Parameters
- campaignActivityId string - The unique ID for an email campaign activity
Return Type
- EmailCampaignActivityPreview|error - The HTML preview of the email campaign activity
listEmailSendHistory
function listEmailSendHistory(string campaignActivityId, map<string|string[]> headers) returns EmailSendHistory|errorGET the Send History of an Email Campaign Activity
Parameters
- campaignActivityId string - The unique ID for an email campaign activity. You can return the send history for
primary_emailandresendrole email campaign activities
Return Type
- EmailSendHistory|error - The send history of the email campaign activity
getNonOpenerResend
function getNonOpenerResend(string campaignActivityId, map<string|string[]> headers) returns ResendToNonOpeners|errorGET Details for a Resend to Non-openers Campaign Activity
Parameters
- campaignActivityId string - The unique ID for the primary email campaign activity
Return Type
- ResendToNonOpeners|error - The resend to non-openers details
createNonOpenerResend
function createNonOpenerResend(string campaignActivityId, ResendToNonOpenersInput payload, map<string|string[]> headers) returns ResendToNonOpenersObject|errorPOST a Resend to Non-openers Campaign Activity
Parameters
- campaignActivityId string - The unique ID for the primary email campaign activity
- payload ResendToNonOpenersInput - A JSON request body that specifies when to resend the campaign activity to non-openers
Return Type
- ResendToNonOpenersObject|error - The created resend to non-openers activity
deleteNonOpenerResend
function deleteNonOpenerResend(string campaignActivityId, string resendRequestId, map<string|string[]> headers) returns error?DELETE a Resend to Non Openers Activity
Parameters
- campaignActivityId string - The unique ID for the primary email campaign activity
- resendRequestId string - The unique ID associated with the resend for the email campaign activity (for example:
389093). If the email campaign activity is currently in draft status, specifyDRAFTas the ID
Return Type
- error? - The resend to non-openers activity was deleted; no content is returned
listAutomations
function listAutomations(map<string|string[]> headers, *ListAutomationsQueries queries) returns ListAutomationFlowsResponseDto|errorList All Automations
Parameters
- queries *ListAutomationsQueries - Queries to be sent with the request
Return Type
- ListAutomationFlowsResponseDto|error - The collection of automations
createAutomation
function createAutomation(TriggerDefDto payload, map<string|string[]> headers, *CreateAutomationQueries queries) returns AutomationCampaign|errorCreate an Automation
Parameters
- payload TriggerDefDto - Automation trigger definition (type, action_name, parameters, optional trigger_date and bounds)
- queries *CreateAutomationQueries - Queries to be sent with the request
Return Type
- AutomationCampaign|error - The created automation
getAutomation
function getAutomation(string automationFlowId, map<string|string[]> headers) returns AutomationCampaign|errorRetrieve an Automation
Parameters
- automationFlowId string - Automation workflow identifier
Return Type
- AutomationCampaign|error - The requested automation
updateAutomation
function updateAutomation(string automationFlowId, AutomationCampaignUpdate payload, map<string|string[]> headers) returns AutomationCampaign|errorUpdate an Automation
Parameters
- automationFlowId string - Automation workflow identifier
- payload AutomationCampaignUpdate - Automation trigger definition (type, action_name, parameters, optional trigger_date and bounds)
Return Type
- AutomationCampaign|error - The updated automation
getEmailCampaignAbTest
function getEmailCampaignAbTest(string campaignActivityId, map<string|string[]> headers) returns ABTestData|errorGET A/B Test Details for an Email Campaign Activity
Parameters
- campaignActivityId string - The unique ID for the primary email campaign activity
Return Type
- ABTestData|error - The A/B test details
createEmailCampaignAbTest
function createEmailCampaignAbTest(string campaignActivityId, ABTestData payload, map<string|string[]> headers) returns ABTestData|errorPOST (Create) an A/B Test for an Email Campaign Activity
Parameters
- campaignActivityId string - The unique ID for the primary email campaign activity
- payload ABTestData - Specify the
alternative_subjectline,test_sizepercentage of contacts (value must from5to50inclusively), and thewinner_wait_duration(value must be6,12,24, or48hours)
Return Type
- ABTestData|error - The created A/B test
deleteEmailCampaignAbTest
function deleteEmailCampaignAbTest(string campaignActivityId, map<string|string[]> headers) returns error?DELETE an A/B Test for an Email Campaign Activity
Parameters
- campaignActivityId string - The unique ID for the primary email campaign activity
Return Type
- error? - A/B test successfully deleted
getContactTracking
function getContactTracking(string contactId, map<string|string[]> headers, *GetContactTrackingQueries queries) returns ContactTrackingActivitiesPage|errorGET Contact Activity Details
Parameters
- contactId string - The contact's ID for which tracking activity data is requested
- queries *GetContactTrackingQueries - Queries to be sent with the request
Return Type
- ContactTrackingActivitiesPage|error - Activity details for the contact
getContactOpenClickRate
function getContactOpenClickRate(string contactId, map<string|string[]> headers, *GetContactOpenClickRateQueries queries) returns ContactOpenAndClickRates|errorGET Average Open and Click Rates
Parameters
- contactId string - The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
- queries *GetContactOpenClickRateQueries - Queries to be sent with the request
Return Type
- ContactOpenAndClickRates|error - The contact's average open and click rates
getContactActivitySummary
function getContactActivitySummary(string contactId, map<string|string[]> headers, *GetContactActivitySummaryQueries queries) returns ContactCampaignActivitiesSummary|errorGET Contact Action Summary
Parameters
- contactId string - The contact id which is requesting tracking activity data (e.g. aa9ff7b0-478d-11e6-8059-00163e3c8e19)
- queries *GetContactActivitySummaryQueries - Queries to be sent with the request
Return Type
- ContactCampaignActivitiesSummary|error - Summary of activity counts for the contact
getEmailLinksReport
function getEmailLinksReport(string campaignActivityId, map<string|string[]> headers, *GetEmailLinksReportQueries queries) returns EmailLinks|errorGET an Email Links Report
Parameters
- campaignActivityId string - The unique ID for an email campaign activity
- queries *GetEmailLinksReportQueries - Queries to be sent with the request
Return Type
- EmailLinks|error - The email links report
getEmailSends
function getEmailSends(string campaignActivityId, map<string|string[]> headers, *GetEmailSendsQueries queries) returns SendsTrackingActivitiesPage|errorGET an Email Sends Report
Parameters
- campaignActivityId string - The unique ID for an email campaign activity to use for this report
- queries *GetEmailSendsQueries - Queries to be sent with the request
Return Type
- SendsTrackingActivitiesPage|error - A page of email send tracking activities
getEmailOpens
function getEmailOpens(string campaignActivityId, map<string|string[]> headers, *GetEmailOpensQueries queries) returns OpensTrackingActivitiesPage|errorGET an Email Opens Report
Parameters
- campaignActivityId string - The unique ID for an email campaign activity to use for this report
- queries *GetEmailOpensQueries - Queries to be sent with the request
Return Type
- OpensTrackingActivitiesPage|error - A page of email open tracking activities
getEmailUniqueOpens
function getEmailUniqueOpens(string campaignActivityId, map<string|string[]> headers, *GetEmailUniqueOpensQueries queries) returns OpensTrackingActivitiesPage|errorGET an Email Unique Opens Report
Parameters
- campaignActivityId string - The ID that uniquely identifies the email campaign activity to use for this report
- queries *GetEmailUniqueOpensQueries - Queries to be sent with the request
Return Type
- OpensTrackingActivitiesPage|error - A page of unique email open tracking activities
getEmailDidNotOpens
function getEmailDidNotOpens(string campaignActivityId, map<string|string[]> headers, *GetEmailDidNotOpensQueries queries) returns DidNotOpensTrackingActivitiesPage|errorGET an Email Did Not Opens Report
Parameters
- campaignActivityId string - The ID that uniquely identifies the email campaign activity to use for this report
- queries *GetEmailDidNotOpensQueries - Queries to be sent with the request
Return Type
- DidNotOpensTrackingActivitiesPage|error - A page of contacts who did not open the email
getEmailClicks
function getEmailClicks(string campaignActivityId, map<string|string[]> headers, *GetEmailClicksQueries queries) returns ClicksTrackingActivitiesPage|errorGET an Email Clicks Report
Parameters
- campaignActivityId string - The ID that uniquely identifies the email campaign activity to use for this report
- queries *GetEmailClicksQueries - Queries to be sent with the request
Return Type
- ClicksTrackingActivitiesPage|error - A page of email click tracking activities
getEmailForwards
function getEmailForwards(string campaignActivityId, map<string|string[]> headers, *GetEmailForwardsQueries queries) returns ForwardsTrackingActivitiesPage|errorGET an Email Forwards Report
Parameters
- campaignActivityId string - The ID that uniquely identifies the email campaign activity to use for this report
- queries *GetEmailForwardsQueries - Queries to be sent with the request
Return Type
- ForwardsTrackingActivitiesPage|error - A page of email forward tracking activities
getEmailOptouts
function getEmailOptouts(string campaignActivityId, map<string|string[]> headers, *GetEmailOptoutsQueries queries) returns OptoutsTrackingActivitiesPage|errorGET an Email Opt-outs Report
Parameters
- campaignActivityId string - The ID that uniquely identifies the email campaign activity to use for this report
- queries *GetEmailOptoutsQueries - Queries to be sent with the request
Return Type
- OptoutsTrackingActivitiesPage|error - A page of email opt-out tracking activities
getEmailBounces
function getEmailBounces(string campaignActivityId, map<string|string[]> headers, *GetEmailBouncesQueries queries) returns BouncesTrackingActivitiesPage|errorGET an Email Bounces Report
Parameters
- campaignActivityId string - The ID that uniquely identifies the email campaign activity to use for this report
- queries *GetEmailBouncesQueries - Queries to be sent with the request
Return Type
- BouncesTrackingActivitiesPage|error - A page of email bounce tracking activities
getCampaignPerformanceStats
function getCampaignPerformanceStats(map<string|string[]> headers, *GetCampaignPerformanceStatsQueries queries) returns CampaignPerformanceStatsQueryResult|errorGET Campaign Performance Statistics
Parameters
- queries *GetCampaignPerformanceStatsQueries - Queries to be sent with the request
Return Type
- CampaignPerformanceStatsQueryResult|error - The campaign performance statistics
getEmailCampaignSummaries
function getEmailCampaignSummaries(map<string|string[]> headers, *GetEmailCampaignSummariesQueries queries) returns BulkEmailCampaignSummariesPage|errorGET an Email Campaigns Summary Report
Parameters
- queries *GetEmailCampaignSummariesQueries - Queries to be sent with the request
Return Type
- BulkEmailCampaignSummariesPage|error - A page of email campaign summaries
getEmailCampaignStats
function getEmailCampaignStats(string campaignIds, map<string|string[]> headers) returns CampaignStatsQueryResultEmail|errorGET an Email Campaign Stats Report
Parameters
- campaignIds string - A comma-separated list of
campaign_ids (UUID's)
Return Type
- CampaignStatsQueryResultEmail|error - The statistics for the email campaigns
getEmailCampaignActivityStats
function getEmailCampaignActivityStats(string campaignActivityIds, map<string|string[]> headers) returns CampaignActivityStatsQueryResultEmail|errorGET an Email Campaign Activity Stats Report
Parameters
- campaignActivityIds string - A comma-separated list of
campaign_activity_ids (UUID's)
Return Type
- CampaignActivityStatsQueryResultEmail|error - The statistics for the email campaign activities
getLandingPageUniqueContactClicks
function getLandingPageUniqueContactClicks(string campaignActivityId, map<string|string[]> headers, *GetLandingPageUniqueContactClicksQueries queries) returns PContactClickTrackingActivitiesPage|errorGET a Unique Contacts Clicks Landing Page Report
Parameters
- campaignActivityId string - The landing page
campaign_activity_id(UUID's) to use to get unique contact click results
- queries *GetLandingPageUniqueContactClicksQueries - Queries to be sent with the request
Return Type
- PContactClickTrackingActivitiesPage|error - A page of unique contact clicks on the landing page
getLandingPageUniqueContactOpens
function getLandingPageUniqueContactOpens(string campaignActivityId, map<string|string[]> headers, *GetLandingPageUniqueContactOpensQueries queries) returns PContactOpensTrackingActivitiesPage|errorGET a Unique Contacts Opens Landing Page Report
Parameters
- campaignActivityId string - The landing page
campaign_activity_id(UUID's) to use to get unique contact open results
- queries *GetLandingPageUniqueContactOpensQueries - Queries to be sent with the request
Return Type
- PContactOpensTrackingActivitiesPage|error - A page of unique contact opens of the landing page
getLandingPageContactOpens
function getLandingPageContactOpens(string campaignActivityId, map<string|string[]> headers, *GetLandingPageContactOpensQueries queries) returns PContactOpensTrackingActivitiesPage|errorGET a Contacts Opens Landing Page Report
Parameters
- campaignActivityId string - The landing page
campaign_activity_id(UUID's) to use to get unique contact open results
- queries *GetLandingPageContactOpensQueries - Queries to be sent with the request
Return Type
- PContactOpensTrackingActivitiesPage|error - A page of contact opens of the landing page
getLandingPageUniqueContactUpdates
function getLandingPageUniqueContactUpdates(string campaignActivityId, map<string|string[]> headers, *GetLandingPageUniqueContactUpdatesQueries queries) returns PContactUpdateTrackingActivitiesPage|errorGET a Unique Contacts Updates Landing Page Report
Parameters
- campaignActivityId string - The landing page
campaign_activity_id(UUID's) to use to get unique contact open results
- queries *GetLandingPageUniqueContactUpdatesQueries - Queries to be sent with the request
Return Type
- PContactUpdateTrackingActivitiesPage|error - A page of unique contact updates from the landing page
getLandingPageUniqueContactAdds
function getLandingPageUniqueContactAdds(string campaignActivityId, map<string|string[]> headers, *GetLandingPageUniqueContactAddsQueries queries) returns PContactAddTrackingActivitiesPage|errorGET a Unique Contacts Adds Landing Page Report
Parameters
- campaignActivityId string - The landing page
campaign_activity_id(UUID's) to use to get unique contact results
- queries *GetLandingPageUniqueContactAddsQueries - Queries to be sent with the request
Return Type
- PContactAddTrackingActivitiesPage|error - A page of unique contacts added from the landing page
getLandingPageUniqueContactSmsOptIns
function getLandingPageUniqueContactSmsOptIns(string campaignActivityId, map<string|string[]> headers, *GetLandingPageUniqueContactSmsOptInsQueries queries) returns PContactSMSOptInTrackingActivitiesPage|errorGET a Unique Contacts SMS Opt-In Landing Page Report
Parameters
- campaignActivityId string - The landing page
campaign_activity_id(UUID's) to use to get unique contact click results
- queries *GetLandingPageUniqueContactSmsOptInsQueries - Queries to be sent with the request
Return Type
- PContactSMSOptInTrackingActivitiesPage|error - A page of unique contact SMS opt-ins from the landing page
getSmsCampaignSummaries
function getSmsCampaignSummaries(map<string|string[]> headers, *GetSmsCampaignSummariesQueries queries) returns SmsCampaignSummariesPage|errorGET an SMS Campaigns Summary Report
Parameters
- queries *GetSmsCampaignSummariesQueries - Queries to be sent with the request
Return Type
- SmsCampaignSummariesPage|error - A page of SMS campaign summaries
listPartnerAccounts
function listPartnerAccounts(map<string|string[]> headers, *ListPartnerAccountsQueries queries) returns PartnerAccount|errorGET Partner Client Accounts
Parameters
- queries *ListPartnerAccountsQueries - Queries to be sent with the request
Return Type
- PartnerAccount|error - The partner client accounts
createPartnerAccount
function createPartnerAccount(Provision payload, map<string|string[]> headers) returns ProvisionResponse|errorPOST (create) a Partner Client Account
Parameters
- payload Provision - Create a new Constant Contact client account under your partner account. All required properties must be included in the JSON payload request
Return Type
- ProvisionResponse|error - The provisioned client account
getPartnerAccountPlan
function getPartnerAccountPlan(string encodedAccountId, map<string|string[]> headers) returns PlanTiersObject|errorGET Billing Plan Details for a Client Account
Parameters
- encodedAccountId string - Specify the client's unique
encoded_account_id
Return Type
- PlanTiersObject|error - The billing plan for the client account
updatePartnerAccountPlan
function updatePartnerAccountPlan(string encodedAccountId, PlanInfo payload, map<string|string[]> headers) returns PlanTiersObject|errorPUT (update) Billing Plan Details for a Client Account
Parameters
- encodedAccountId string - Specify the client's unique
encoded_account_id
- payload PlanInfo -
plan_type: Updates the billing plan assigned to a client account to a differentplan_type.
Return Type
- PlanTiersObject|error - The updated billing plan
cancelPartnerAccountPlan
function cancelPartnerAccountPlan(string encodedAccountId, AccountCancellation payload, map<string|string[]> headers) returns AccountCancellation|errorPUT Cancel the Billing Plan for a Client Account
Parameters
- encodedAccountId string - The system generated ID that uniquely identifies the client account
- payload AccountCancellation - By default, the current date and time is automatically used as the cancellation date. However, you can specify a future date and time to cancel the account (
effective_date) in the request body in ISO format. You can also enter the client's cancellation reason (reason_id)
Return Type
- AccountCancellation|error - The billing plan cancellation details
sendPartnerAccountRequest
function sendPartnerAccountRequest(string encodedAccountId, PartnerAccountOperationsRequest payload, map<string|string[]> headers) returns error?POST Send an API request on Behalf of a Client Account
Parameters
- encodedAccountId string - An encoded account id for a managed account in your partnership
- payload PartnerAccountOperationsRequest - A JSON request body that contains the structure of the HTTP request you are instructing Constant Contact to send on behalf of specific managed account in your partnership
Return Type
- error? - The response to the proxied request; its schema depends on the API request sent in the body
createPartnerSsoUser
function createPartnerSsoUser(string encodedAccountId, SSOUser payload, map<string|string[]> headers) returns error?POST a User Under a Partner's SSO-Enabled Client Account
Parameters
- encodedAccountId string - The encoded account ID that identifies the partner's client account to which to add the new user.
- payload SSOUser - The JSON payload used to create a new user under the specified partner's client account. All request body properties are required (
first_name,last_name,role_name,contact_email,login_name,external_id,external_provider)
Return Type
- error? - The SSO user was created under the client account
unsubscribePartnerContacts
function unsubscribePartnerContacts(string encodedAccountId, ContactsUnsubscribeBody payload, map<string|string[]> headers) returns PartnerUnsubscribeResponse|errorPOST Unsubscribe Contacts
Parameters
- encodedAccountId string - The encoded account ID that uniquely identifies the partner's client account
- payload ContactsUnsubscribeBody - The JSON payload
Return Type
- PartnerUnsubscribeResponse|error - Contacts were successfully unsubscribed
listWebhookSubscriptions
function listWebhookSubscriptions(map<string|string[]> headers) returns WebhooksSubscriptionCollection|errorGET a Collection of Webhook Topic Subscriptions
Return Type
- WebhooksSubscriptionCollection|error - The webhook topic subscriptions
getWebhookSubscription
function getWebhookSubscription(string topicId, map<string|string[]> headers) returns WebhooksSubscriptionResponse|errorGET Webhook Topic Subscription
Parameters
- topicId string - Identifies a webhook topic
Return Type
- WebhooksSubscriptionResponse|error - The webhook topic subscription
updateWebhookSubscription
function updateWebhookSubscription(string topicId, WebhooksSubscriptionBody payload, map<string|string[]> headers) returns WebhooksSubscriptionPutResp|errorPUT Webhook Topic Subscription
Parameters
- topicId string - Identifies a webhook topic
- payload WebhooksSubscriptionBody - A JSON payload containing a callback URI. Constant Contact uses this callback URI to notify you about your chosen topic
Return Type
- WebhooksSubscriptionPutResp|error - The updated webhook topic subscription
deleteWebhookSubscription
DELETE Webhook Topic Subscriptions
Parameters
- topicId string - Identifies a webhook topic
Return Type
- error? - Webhooks subscription successfully deleted
sendTestWebhook
function sendTestWebhook(string topicId, map<string|string[]> headers) returns WebhooksTestSend|errorPOST Test Send Webhook Notification
Parameters
- topicId string - Identifies a webhook topic
Return Type
- WebhooksTestSend|error - Test notification successfully sent to your callback URI
Records
constantcontact: ABTestData
Fields
- winnerWaitDuration Signed32 - The number of hours Constant Contact waits after the A/B test is sent before determining the winning subject line. The winner is the subject line with the highest number of contact opens. Valid values include <code>6</code>, <code>12</code>, <code>24</code>, and <code>48</code>. After the winner is determined, Constant Contact automatically sends the email campaign with the winning subject line to all the remaining contacts, which did not participate in the A/B test
- testSize Signed32 - The percentage of contact recipients to participate in the A/B Test. For example, if the value is 30, then 30% of contacts will receive the email campaign with subject line A, and 30% of contacts will receive the email campaign with subject line B. Valid values include <code>5</code> to <code>50</code> percent. Currently, A/B tests support subject line only
- alternativeSubject string - The alternate email subject line to use for A/B testing
constantcontact: AccountCancellation
Specifies the date and time a client requests to cancel their Constant Contact account and changes the account billing_status to Canceled. By default, this is the current date and time in ISO format. In the request body, you can optionally specify a future cancellation date (in ISO format) and a reason (reason_code) that the client wants to cancel their account
Fields
- effectiveDate? string - The client account cancellation date and time in ISO-8601 format
- reasonId? Signed32 - Specifies the reason that the client is canceling their Constant Contact account as follows: <ul> <li><code>1</code> Cost Too High</li> <li><code>2</code> Using A Competitive Service</li> <li><code>3</code> Not Doing Email Marketing</li> <li><code>11</code> Something Missing Or Not Working </li> <li><code>12</code> Doing It In-House</li> <li><code>14</code> Poor Results</li> <li><code>21</code> Too Difficult To Use</li> <li><code>27</code> Canceled Online by Customer</li> <li><code>30</code> Dissatisfied With Billing Policies</li> </ul>
constantcontact: AccountEmailCreateResponse
Fields
- emailId? int - The unique ID for an email address in a Constant Contact account
- emailAddress? string - An email address associated with a Constant Contact account owner
- confirmStatus? string - The confirmation status of the account email address. When you add a new email address to an account, Constant Contact automatically sends an email to that address with a link to confirm it. You can use any account email address with a <code>CONFIRMED</code> status to create an email campaign
constantcontact: AccountEmailInput
Fields
- emailAddress? string - The new email address you want to add to a Constant Contact account
constantcontact: AccountEmailsInner
Fields
- emailId? int - The unique ID for an email address in a Constant Contact account
- confirmSourceType? string - Describes who confirmed the email address. Valid values are: <ul> <li>SITE_OWNER — The Constant Contact account owner confirmed the email address.</li> <li>SUPPORT — Constant Contact support staff confirmed the email address.</li> <li>FORCEVERIFY — Constant Contact confirmed the email address without sending a confirmation email.</li> <li>PARTNER — A Constant Contact partner confirmed the email address.</li> </ul>
- emailAddress? string - An email address associated with a Constant Contact account owner
- roles? string[] - Specifies the current role of a confirmed email address in an account. Each email address can have multiple roles or no role. Possible role values are: <ul> <li>CONTACT — The contact email for the Constant Contact account owner. Each account can only have one <code>CONTACT</code> role email.</li> <li>BILLING — The billing address for the Constant Contact account. Each account can only have one <code>BILLING</code> role email.</li> <li>JOURNALING — An email address that Constant Contact forwards all sent email campaigns to as part of the partner journaling compliance feature.</li> <li>REPLY_TO — The contact email used in the email campaign signature. Each account can only have one <code>REPLY_TO</code> role email.</li> <li>OTHER — An email address that does not fit into the other categories.</li> </ul> You can use any confirmed email address in the email campaign <code>from_email</code> and <code>reply_to_email</code> headers
- pendingRoles? string[] - The planned role for an unconfirmed email address. Possible role values are: <ul> <li>CONTACT — The contact email for the Constant Contact account owner. Each account can only have one <code>CONTACT</code> role email.</li> <li>BILLING — The billing address for the Constant Contact account. Each account can only have one <code>BILLING</code> role email.</li> <li>JOURNALING — The email address that Constant Contact forwards all sent email campaigns to as part of the partner journaling compliance feature.</li> <li>REPLY_TO — The contact email used in the email campaign signature. Each account can only have one <code>REPLY_TO</code> role email. </li> <li>OTHER — An email address that does not fit into the other categories.</li> </ul>
- confirmStatus? string - The confirmation status of the account email address. When you add a new email address to an account, Constant Contact automatically sends an email to that address with a link to confirm it. You can use any account email address with a <code>CONFIRMED</code> status to create an email campaign
- confirmTime? string - The date that the email address changed to <code>CONFIRMED</code> status in ISO-8601 format
constantcontact: AccountInfoDto
Account information for a connected social network user
Fields
- networkAccountId? string - The user identifier on the given network. Note: this is the network <em>account</em> id, not the <em>profile</em> id
- imageUrl? string - URL of the connected user's avatar or image
- accountUrl? string - The account URL of the connected user's profile. Note: Facebook & Instagram do not support this
- displayName? string - Display name of the connected user
- network? string - The social network this account belongs to
- username? string - Username of the connected user on the social network
constantcontact: AccountPhysicalAddress
Fields
- countryCode string - The two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's country
- addressLine3? string - Line 3 of the organization's street address
- addressLine2? string - Line 2 of the organization's street address
- addressLine1 string - Line 1 of the organization's street address
- city string - The city where the organization is located
- stateName? string - Use if the state where the organization is physically located is not in the United States or Canada. If <code>country_code</code> is <code>US</code> or <code>CA</code>, exclude this property from the request body
- stateCode? string - The two letter ISO 3166-1 code for the organization's state and only used if the <code>country_code</code> is <code>US</code> or <code>CA</code>. If not, exclude this property from the request body
- postalCode? string - The postal code address (ZIP code) of the organization. This property is required if the <code>state_code</code> is <code>US</code> or <code>CA</code>, otherwise exclude this property from the request body
constantcontact: Activities
Fields
- links? PagingLinks -
- activities? ActivitiesActivities[] - A list of bulk activity jobs and status submitted by the account over the past 10 days
constantcontact: ActivitiesActivities
Generic bulk activity status response object
Fields
- completedAt? string - Timestamp showing when we completed processing the activity, in ISO-8601 format
- percentDone? int - Shows the percent done for an activity that we are still processing
- updatedAt? string - Timestamp showing when we last updated the activity, in ISO-8601 format
- links? ActivityStatusExportLink -
- activityId? string - Unique ID for the activity
- activityErrors? string[] - Array of messages describing the errors that occurred
- startedAt? string - Timestamp showing when we began processing the activity request, in ISO-8601 format
- createdAt? string - Timestamp showing when we created the activity, in ISO-8601 format
- state? string - The state of the request: <p><ul> <li>initialized - request has been received</li> <li>processing - request is being processed</li> <li>completed - job completed</li> <li>cancelled - request was cancelled</li> <li>failed - job failed to complete</li> <li>timed_out - the request timed out before completing"</li> </ul> </p>
- sourceFileName? string - Name of the file used for an add_contacts activity
- status? ActivityStatus -
constantcontact: ActivitiesContactsFileImportBody
Fields
- file record { fileContent byte[], fileName string } - The CSV file you are importing must include either
emailorsms_numberas a column heading. Other properties you can include using column headings are:first_name.last_name,phone,job_title,anniversary,birthday_day,birthday_month,company_name,street,street2,city,state,zip,country, andsms_consent_date. If adding ansms_number, you must also include thesms_permission_to_sendparameter and set it to eithernot_setorexplicit. Ifexplicit, requires includingsms_consent_dateas a column header to specify the date the contact consented to receiving SMS messages. You can also use custom fields as column headings. Enter the custom field name prefixed withcf:as the column heading. For example, usecf:first_nameas the header name if you have a custom field named "first_name". The custom field must already exist in the Constant Contact account you are using. Depending on the custom field data type, you can enter dates or strings as the value of the custom field. Each contact can contain up to 25 different custom fields
- smsPermissionToSend? "not_set"|"explicit" - If importing contact
sms_numbers, use this parameter to specify how SMS consent was provided. If all contacts in the file provided their consent, set toexplicitand include each contact'ssms_consent_date. If all contacts in the file have not yet provided consent, set tonot_set(sms_consent_dateis not required). You cannot message a contact that does not have a sms consent date set
- listIds string - Specify which contact lists you are adding all imported contacts to as an array of up to 50 contact
list_idvalues
constantcontact: Activity
Generic bulk activity status response object
Fields
- completedAt? string - Timestamp showing when we completed processing the activity, in ISO-8601 format
- percentDone? int - Shows the percent done for an activity that we are still processing
- updatedAt? string - Timestamp showing when we last updated the activity, in ISO-8601 format
- links? ActivityStatusExportLink -
- activityId? string - Unique ID for the activity
- activityErrors? string[] - Array of messages describing the errors that occurred
- startedAt? string - Timestamp showing when we began processing the activity request, in ISO-8601 format
- createdAt? string - Timestamp showing when we created the activity, in ISO-8601 format
- state? string - The state of the request: <p><ul> <li>initialized - request has been received</li> <li>processing - request is being processed</li> <li>completed - job completed</li> <li>cancelled - request was cancelled</li> <li>failed - job failed to complete</li> <li>timed_out - the request timed out before completing"</li> </ul> </p>
- sourceFileName? string - Name of the file used for an add_contacts activity
- status? ActivityStatus -
constantcontact: ActivityDeleteCustomFields
Activity status for contact_delete activity
Fields
- completedAt? string - Timestamp showing when we completed processing the activity, in ISO-8601 format
- percentDone? int - Shows the percent done for an activity that we are still processing
- updatedAt? string - Timestamp showing when we last updated the activity, in ISO-8601 format
- links? ActivityDeleteStatusLinks -
- activityId? string - Unique ID for the activity
- activityErrors? string[] - Array of messages describing the errors that occurred
- startedAt? string - Timestamp showing when we began processing the activity request, in ISO-8601 format
- createdAt? string - Timestamp showing when we created the activity, in ISO-8601 format
- state? string - The state of the request: <p><ul> <li>initialized - request has been received</li> <li>processing - request is being processed</li> <li>completed - job completed</li> <li>cancelled - request was cancelled</li> <li>failed - job failed to complete</li> <li>timed_out - the request timed out before completing"</li> </ul> </p>
constantcontact: ActivityDeleteListResponse
Fields
- percentDone? int - Job completion percentage
- updatedAt? string - Date and time that the request status was updated, in ISO-8601 format
- links? ActivityDeleteListsResponseLinks -
- activityId? string - Unique ID for the delete list batch job
- activityErrors? string[] - Array of messages describing the errors that occurred
- createdAt? string - Date and time that the request was received, in ISO-8601 format
- state? string - The state of the request: <p><ul> <li>initialized - request has been received</li> <li>processing - request is being processed</li> <li>completed - job completed</li> <li>cancelled - request was cancelled</li> <li>failed - job failed to complete</li> <li>timed_out - the request timed out before completing"</li> </ul> </p>
constantcontact: ActivityDeleteListsResponse
Fields
- completedAt? string - Timestamp showing when processing completed for the activity, in ISO-8601 format
- percentDone? int - The processing percent complete for the activity
- updatedAt? string - Timestamp showing when the activity was last updated, in ISO-8601 format
- links? ActivityDeleteListsResponseLinks -
- activityId? string - The system assigned UUID that uniquely identifies an activity
- activityErrors? string[] - An array of error message strings describing the errors that occurred
- startedAt? string - Timestamp showing when processing started for the activity, in ISO-8601 format
- createdAt? string - Timestamp showing when the activity was first requested, in ISO-8601 format
- state? string - The activity processing state
- status? ActivityDeleteListsResponseStatus -
constantcontact: ActivityDeleteListsResponseLinks
Fields
- self? ActivityDeleteListsResponseLinksSelf - Link to the activity status to use in tracking the request status
constantcontact: ActivityDeleteListsResponseLinksSelf
Link to the activity status to use in tracking the request status
Fields
- href? string -
constantcontact: ActivityDeleteListsResponseStatus
Fields
- listCount? int - The number of lists deleted
constantcontact: ActivityDeleteStatus
Activity status for contact_delete activity
Fields
- completedAt? string - Timestamp showing when we completed processing the activity, in ISO-8601 format
- percentDone? int - Shows the percent done for an activity that we are still processing
- updatedAt? string - Timestamp showing when we last updated the activity, in ISO-8601 format
- links? ActivityDeleteStatusLinks -
- activityId? string - Unique ID for the activity
- activityErrors? string[] - Array of messages describing the errors that occurred
- startedAt? string - Timestamp showing when we began processing the activity request, in ISO-8601 format
- createdAt? string - Timestamp showing when we created the activity, in ISO-8601 format
- state? string - The state of the request: <p><ul> <li>initialized - request has been received</li> <li>processing - request is being processed</li> <li>completed - job completed</li> <li>cancelled - request was cancelled</li> <li>failed - job failed to complete</li> <li>timed_out - the request timed out before completing"</li> </ul> </p>
- status? ActivityDeleteStatusStatus -
constantcontact: ActivityDeleteStatusLinks
Fields
- self? ActivityDeleteStatusLinksSelf - Link to the activity status (this object) to retrieve the activity status
constantcontact: ActivityDeleteStatusLinksSelf
Link to the activity status (this object) to retrieve the activity status
Fields
- href? string -
constantcontact: ActivityDeleteStatusStatus
Fields
- itemsCompletedCount? int - The number of contacts deleted
- listCount? int - The number of lists if request specifies contacts to delete by list_ids
- itemsTotalCount? int - The total number of contacts to delete
constantcontact: ActivityErrors
Fields
- message? string - Message describing the error condition
constantcontact: ActivityExportStatus
Activity status for contact_exports activity
Fields
- completedAt? string - Timestamp showing when we completed processing the activity, in ISO-8601 format
- percentDone? int - Shows the percent done for an activity that we are still processing
- updatedAt? string - Timestamp showing when we last updated the activity, in ISO-8601 format
- links? ActivityStatusExportLink -
- activityId? string - Unique ID for the activity
- activityErrors? string[] - Array of messages describing the errors that occurred
- startedAt? string - Timestamp showing when we began processing the activity request, in ISO-8601 format
- createdAt? string - Timestamp showing when we created the activity, in ISO-8601 format
- state? string - <p> The state of the request: <ul> <li>initialized - request has been received</li> <li>processing - request is being processed</li> <li>completed - job completed</li> <li>cancelled - request was cancelled</li> <li>failed - job failed to complete</li> <li>timed_out - the request timed out before completing"</li> </ul> </p>
- status? ActivityExportStatusStatus -
constantcontact: ActivityExportStatusStatus
Fields
- itemsCompletedCount? int - The number of contacts processed for export
- itemsTotalCount? int - The total number of contacts to export
constantcontact: ActivityGeneric
Fields
- percentDone? int - The percentage complete for the specified activity
- updatedAt? string - The system generated date and time that the resource was last updated, in ISO-8601 format
- links? TagsActivityLinks -
- activityId string - The ID that uniquely identifies the activity
- activityErrors? ActivityErrors[] - An array of error messages if errors occurred for a specified activity. The system returns an empty array if no errors occur
- createdAt? string - The system generated date and time that the resource was created, in ISO-8601 format
- state string - The processing state for the activity
- status? ActivityGenericStatus -
constantcontact: ActivityGenericStatus
Fields
- itemsCompletedCount? int - The number of tags that this activity has currently deleted
- itemsTotalCount? int - The total number of tags that this activity will delete
constantcontact: ActivityImport
Activity status for contacts_json_import and contacts_file_import activities
Fields
- completedAt? string - Timestamp showing when we completed processing the activity, in ISO-8601 format
- percentDone? int - Shows the percent done for an activity that we are still processing
- updatedAt? string - Timestamp showing when we last updated the activity, in ISO-8601 format
- links? ActivityStatusLink -
- activityId? string - Unique ID for the activity
- activityErrors? string[] - Array of messages describing the errors that occurred
- startedAt? string - Timestamp showing when we began processing the activity request, in ISO-8601 format
- createdAt? string - Timestamp showing when we created the activity, in ISO-8601 format
- state? string - The state of the request: <p><ul> <li>initialized - request has been received</li> <li>processing - request is being processed</li> <li>completed - job completed</li> <li>cancelled - request was cancelled</li> <li>failed - job failed to complete</li> <li>timed_out - the request timed out before completing"</li> </ul> </p>
- sourceFileName? string - Name of the file used for an file_import activity
- status? ActivityImportStatus -
constantcontact: ActivityImportStatus
Fields
- correctableCount? int - The number of correctable errors. Correctable errors are: invalid email address format, birthday or anniversary format error, or does not have minimal contact information (no name or email address). Correctable errors are available in the product UI to correct
- cannotAddToListCount? int - The number of previously unsubscribed contacts in the import - they cannot be added to a list
- itemsTotalCount? int - The total number of rows, including the header row, in the import file
- errorCount? int - The number of non-correctable errors encountered during the file import
- personCount? int - The total number of contacts in the import file
constantcontact: ActivityLinks
Fields
- self? ActivityLinksSelf -
- results? ActivityLinksResults -
constantcontact: ActivityLinksResults
Fields
- href? string - Use this link to view activity results
constantcontact: ActivityLinksSelf
Fields
- href? string -
constantcontact: ActivityListsMembership
Fields
- completedAt? string - Timestamp showing when we completed processing the activity, in ISO-8601 format
- percentDone? int - Shows the percent done for an activity that we are still processing
- updatedAt? string - Timestamp showing when we last updated the activity, in ISO-8601 format
- links? ActivityStatusLink -
- activityId? string - Unique ID for the activity
- activityErrors? string[] - Array of messages describing the errors that occurred
- startedAt? string - Timestamp showing when we began processing the activity request, in ISO-8601 format
- createdAt? string - Timestamp showing when we created the activity, in ISO-8601 format
- state? string - The state of the request: <p><ul> <li>initialized - request has been received</li> <li>processing - request is being processed</li> <li>completed - job completed</li> <li>cancelled - request was cancelled</li> <li>failed - job failed to complete</li> <li>timed_out - the request timed out before completing"</li> </ul> </p>
- status? ActivityListsMembershipStatus -
constantcontact: ActivityListsMembershipStatus
Fields
- itemsCompletedCount? int - The number of contacts processed
- listCount? int - The number of lists specified in the request
- itemsTotalCount? int - Total number of contacts to add to or remove from lists
constantcontact: ActivityReference
Fields
- campaignActivityId? string - The ID (UUID) that uniquely identifies a campaign activity
- role? string - The purpose of the individual campaign activity in the larger email campaign effort. Valid values are: <ul> <li>primary_email — The main email marketing campaign that you send to contacts. The <code>primary_email</code> contains the complete email content.</li> <li>permalink — A permanent link to a web accessible version of the <code>primary_email</code> content without any personalized email information. For example, permalinks do not contain any of the contact details that you add to the <code>primary_email</code> email content. </li> <li>resend — An email campaign that you resend to contacts that did not open the email campaign.</li> </ul> Constant Contact creates a <code>primary_email</code> and a <code>permalink</code> role campaign activity when you create an email campaign
- documentId? string - Identifies the email document used in an email editor (format_type 4) email campaign
constantcontact: ActivityStatus
Fields
- itemsCompletedCount? int - The number of items processed in the activity request
- listCount? int - The number of lists processed in an add or remove list membership activity request
- correctableCount? int - The number of correctable errors. Correctable errors include invalid email address format, birthday or anniversary format error, or does not have minimal contact information (no name or email address). Correctable errors are available in the product UI to correct
- cannotAddToListCount? int - The number of contacts that cannot be added to a list because they were previously unsubscribed, valid for contacts_file_ or json_import requests
- itemsTotalCount? int - The total number of items to be processed
- errorCount? int - The number of non-correctable errors encountered during an import contacts request
- personCount? int - The total number of contacts in an import contacts request
constantcontact: ActivityStatusExportLink
Fields
- self? ActivityStatusExportLinkSelf - HATEOS-style link to the activity status (this object)
- results? ActivityStatusExportLinkResults - Link to an activity result resource; as an example, for file_export, the link to the exported contacts file
constantcontact: ActivityStatusExportLinkResults
Link to an activity result resource; as an example, for file_export, the link to the exported contacts file
Fields
- href? string -
constantcontact: ActivityStatusExportLinkSelf
HATEOS-style link to the activity status (this object)
Fields
- href? string -
constantcontact: ActivityStatusLink
Fields
- self? ActivityStatusExportLinkSelf - HATEOS-style link to the activity status (this object)
constantcontact: ActivityTagging
Fields
- completedAt? string - Timestamp showing when processing completed for the activity, in ISO-8601 format
- percentDone? int - The processing percent complete for the activity
- updatedAt? string - Timestamp showing when the activity was last updated, in ISO-8601 format
- links? ActivityLinks -
- activityId string - The system assigned UUID that uniquely identifies an activity
- activityErrors? string[] - An array of error message strings describing the errors that occurred
- startedAt? string - Timestamp showing when processing started for the activity, in ISO-8601 format
- createdAt? string - Timestamp showing when the activity was first requested, in ISO-8601 format
- state string - The activity processing state
- status? ActivityTaggingStatus - Provides the status for the requested activity
constantcontact: ActivityTaggingStatus
Provides the status for the requested activity
Fields
- itemsCompletedCount? int - The total number of items for which processing completed for the requested activity
- itemsTotalCount? int - The total number of items processed for the requested activity
constantcontact: AddressDto
Fields
- country? string - Name of the country where the event takes place
- addressType string - The address type. Only
EVENTis currently supported
- createTime? string - The create time of the event
- city? string - The city where the event takes place
- latitude? float - The latitude number indicating where the event takes place
- countryCode? string - The country code associated with the country where the event takes place
- lastUpdateTime? string - The last modification time of the event
- locationName? string - The venue name where the event takes place
- state? string - The State/Province where the event takes place
- postalCode? string - The address postal code
- stateCode? string - The state code where the event takes place
- line2? string - The second line of the address where the event takes place
- line1? string - The first line of the address where the event takes place
- longitude? float - The longitude number indicating where the event takes place
constantcontact: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiKey string - API key issued for the application, sent in the x-api-key header
constantcontact: AttributeDto
Fields
- quantityRemaining? Signed32 - The total quantity that remains available for this attribute
- quantitySold? Signed32 - The total quantity sold for this attribute
- lastUpdateTime? string - Last modification time of the event
- quantityTotal? Signed32 - The total quantity available for this attribute
- createTime? string - Create time of the event
- statusLabels? StatusDisplayLabelDto[] -
- attributeId? string - The unique identifier for the attribute
- displayOrder? Signed32 - The order in which the attribute should display
- name string - The name of the attribute
- pausedFlag? boolean - Specifies if the attribute is currently paused from sales
- deletedTime? string - The time when the attribute was deleted
constantcontact: AutomationCampaign
Fields
- activeDefinition? AutomationWorkflowDefinition -
- draftDefinition? AutomationWorkflowDefinition -
- nameExplicitlySet? boolean - Indicates whether the automation campaign name was explicitly set
- name? string - The name of the automation campaign
- description? string - The description of the automation campaign
- id? string - The unique identifier for the automation campaign workflow
- structuredTags? AutomationStructuredTag[] -
- status? string - Computed display status of the workflow
constantcontact: AutomationCampaignUpdate
Fields
- automationFlow? AutomationCampaign -
constantcontact: AutomationFlow
The workflow flow definition
Fields
- workflowDef? AutomationWorkflowDef -
constantcontact: AutomationFlowSummaryDto
Summary of an automation flow
Fields
- description? string - Description of the automation flow
- promotedById? string - User ID who promoted the flow
- structuredTags? StructuredTagDto[] - Structured tags associated with the automation flow
- updateDate? string - Date the flow was last updated
- activeState? string - State of the active definition
- name? string - Display name of the automation flow
- draftState? string - State of the draft definition
- templateId? string - Template ID the flow was created from
- createdById? string - User ID who created the flow
- createdDate? string - Date the flow was created
- id? string - Automation flow ID
- promotedDate? string - Date the flow was promoted
- status? string - Computed display status of the workflow
constantcontact: AutomationStructuredTag
A structured tag with key, value, and display value
Fields
- displayValue? string - Human-readable display value
- value? string - Tag value
- 'key? string - Tag key
constantcontact: AutomationWorkflowDef
The workflow definition containing tasks, status, and metadata
Fields
- metadata? record {} - Workflow metadata
- correlationMetadata? CorrelationMetadataDto -
- upgradable? boolean - Indicates if the workflow can be upgraded after it is activated
- parameters? WorkflowParametersDto -
- tasks? TaskDto[] -
- timeout? TimeoutDto -
- status? string - Workflow definition status
constantcontact: AutomationWorkflowDefinition
A workflow definition containing state, trigger, and workflow structure
Fields
- workflow? AutomationFlow - The workflow flow definition
- state? string - The current state of the workflow definition (e.g. DRAFT, ACTIVE)
- trigger? TriggerDto -
constantcontact: BouncesTrackingActivitiesPage
Fields
- links ReportingLinks -
- trackingActivities BouncesTrackingActivity[] - The list of email bounce tracking activities associated with a given
campaign_activity_id' MISSING[]
constantcontact: BouncesTrackingActivity
Fields
- trackingActivityType string - The type of email tracking activity, <code>em_bounces</code>, that this report includes
- createdTime string - The date and time that the email bounce tracking activity occurred
- campaignActivityId string - The ID that uniquely identifies the email campaign activity
- emailAddress string - The contact's email address that was used when the email campaign activity bounced
- lastName? string - The last name of the contact
- currentEmailAddress? string - The contact's most current email address. If <code>email_address</code> was updated after the email bounce activity occurred, <code>current_ email_address</code> displays the updated address. If updates were not made to <code>email_address</code>, the <code>email_address</code> and <code>current_email_address</code> are the same
- contactId string - The ID that uniquely identifies a contact
- bounceCode string - The one-character string used to specify the reason for the email bounce. Valid codes include: <ul><li><code>B</code> - Non-existent address; the contact's Internet Service Provider (ISP) indicates that the email address doesn't exist.</li> <li><code>D</code> - Undeliverable; after repeated delivery attempts, no response was received from the contact's ISP.</li> <li><code>F</code> - Full; the contact's mailbox is full.</li> <li><code>S</code> - Suspended; the contact's address was reported as non-existent by the ISP and is suspended from delivery.</li> <li><code>V</code> - Vacation/autoreply; the contact set an autoreply, but the message was delivered.</li> <li><code>X</code> - Other; the contact's ISP specified another reason that the message cannot be delivered.</li> <li><code>Z</code> - Blocked; the recipient's ISP chose not to deliver the email. For example, the ISP may have flagged the email as spam.</li></ul>
- firstName? string - The first name of the contact
- deletedAt? string - If applicable, the date when the contact was deleted
constantcontact: BulkCampaignSummary
Fields
- campaignName string - The name to associate with this campaign
- campaignType string - The campaign type
- uniqueCounts UniqueSmsCounts -
- campaignId string - The ID that uniquely identifies the campaign
- lastSentDate string - The date that the campaign was last sent
constantcontact: BulkEmailCampaignSummariesPage
Fields
- links? ReportingLinks -
- bulkEmailCampaignSummaries? BulkEmailCampaignSummary[] - Lists and provides details about each bulk email campaign activity including total unique counts for tracked activities
- aggregatePercents? BulkEmailCampaignSummariesPercents -
constantcontact: BulkEmailCampaignSummariesPercents
Fields
- bounce? decimal - Aggregated bounce rate for campaigns on the current page
- unsubscribe? decimal - Aggregated unsubscribe (optout) rate for campaigns on the current page
- didNotOpen? decimal - Aggregated did-not-open rate for campaigns on the current page
- click? decimal - Aggregated click rate for campaigns on the current page
- open? decimal - Aggregated open rate for campaigns on the current page
constantcontact: BulkEmailCampaignSummary
Fields
- campaignType? string - Identifies the email campaign type
- uniqueCounts? UniqueEmailCounts -
- campaignId string - The ID that uniquely identifies an email campaign
- lastSentDate? string - The date and time that the email campaign was last sent
constantcontact: BulkSmsCampaignSummariesPercents
Fields
- bounce? decimal - The aggregated bounce rate for all campaigns on the current results page
- unsubscribe? decimal - The aggregated unsubscribe (opt-out) rate for all campaigns on the current results page
- deliver? decimal - The aggregated SMS delivery rate for all campaigns on the current results page
- click? decimal - The aggregated click rate for all campaigns on the current results page
constantcontact: CampaignActivityStatsQueryResultEmail
Fields
- results? CampaignActivityStatsResultGenericStatsEmailActivity[] - An array of results containing statistics for each requested campaign activity
- errors? StatsError[] - Array of errors indicating any partial failures in the query
constantcontact: CampaignActivityStatsResultGenericStatsEmailActivity
Fields
- campaignActivityId? string - The unique ID used to identify the campaign activity (UUID)
- stats? StatsEmailActivity -
- lastRefreshTime? string - The time at which the campaign activity stats were last refreshed in ISO 8601 format (e.g. '2015-08-25T22:00:09.908Z')
- campaignId? string - The unique ID used to identify the campaign (UUID)
constantcontact: CampaignActivitySummary
Fields
- startOn string - The last date at which the email was sent to this contact
- emClicks Signed32 - The number of times this contact has clicked a link in this email
- campaignActivityId string - The unique id of the activity for an e-mail campaign
- emForwards Signed32 - The number of times this contact has forwarded this email
- emOpens Signed32 - The number of times this contact has opened this email
- emBounces Signed32 - The number of times the email has bounced for this contact
- emUnsubscribes Signed32 - The number of times this contact has opted out
- emSends Signed32 - The number of times the email was sent to this contact
constantcontact: CampaignPerformanceStats
Fields
- campaignName? string - The campaign name
- clickRatePrecisionOne? decimal - Total clicks opens divided by (total sends - total bounces) with one decimal precision
- clickRate? decimal - Total email clicks divided by (total sends - total bounces)
- opens? Signed32 - Total unique email opens count
- clicks? Signed32 - Total unique email clicks count
- lastSendDate? string - The last sent date-time of the campaign in ISO 8601 format (e.g. '2019-11-26T10:30:00.000Z')
- openRatePrecisionOne? decimal - Total email opens divided by (total sends - total bounces) with one decimal precision
- campaignId? string - The campaign UUID
- openRate? decimal - Total email opens divided by (total sends - total bounces)
constantcontact: CampaignPerformanceStatsQueryResult
Fields
- bottom? CampaignPerformanceStatsResult -
- errors? StatsError[] - Array of errors indicating any partial failures in the query
constantcontact: CampaignPerformanceStatsResult
Fields
- clickRate? CampaignPerformanceStats[] - Array of results containing click rates sorted by highest to lowest or by lowest to highest for requested account id
- opens? CampaignPerformanceStats[] - Array of results containing sorted unique opens count for each requested account id
- clicks? CampaignPerformanceStats[] - Array of results containing sorted unique opens count for each requested account id
- openRate? CampaignPerformanceStats[] - Array of results containing open rates sorted by highest to lowest or by lowest to highest for requested account id
constantcontact: CampaignStatsQueryResultEmail
Fields
- results? CampaignStatsResultGenericStatsEmailPercentsEmail[] - An array of results listing statistics for each requested <code>campaign_id</code>
- errors? StatsError[] - An array of errors indicating any partial failures in the query
constantcontact: CampaignStatsResultGenericStatsEmailPercentsEmail
Fields
- stats? StatsEmail -
- lastRefreshTime? string - The date and time that the campaign stats were last refreshed
- percents? PercentsEmail -
- campaignId? string - The ID that uniquely identifies the campaign (UUID)
constantcontact: ClicksTrackingActivitiesPage
Fields
- links? ReportingLinks -
- trackingActivities ClicksTrackingActivity[] - The list of click tracking activities
constantcontact: ClicksTrackingActivity
Fields
- trackingActivityType string - The type of report tracking activity that is associated with the specified <code>campaign_activity_id</code>
- createdTime string - The date and time that the contact clicked the specified URL link for the email campaign activity
- campaignActivityId string - The ID that uniquely identifies the email campaign activity
- emailAddress string - The email address used to send the email campaign activity to a contact
- lastName? string - The last name of the contact
- linkUrl string - The text used for the URL link
- deviceType? string - The type of device that the contact was using when they clicked the URL link for the email campaign activity
- urlId string - The ID used to uniquely identify the URL link
- contactId string - The ID that uniquely identifies a contact
- firstName? string - The first name of the contact
- deletedAt? string - If applicable, displays the date that the contact was deleted
constantcontact: CompanyLogo
Fields
- externalUrl? string - The external URL used to get the company logo image file that is hosted on an external website
- internalId? string - The internal ID used to identify the image hosted in your account's MyLibrary
- url? string - The internal URL used to get the company logo image file hosted locally in your account's MyLibrary
constantcontact: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig|ApiKeysConfig - Provides Auth configurations needed when communicating with a remote HTTP endpoint.
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
constantcontact: ConnectionDto
A combination of account information and connection status for an established social network connection
Fields
- connectionStatus? ConnectionStatusDto -
- accountInfo? AccountInfoDto -
constantcontact: ConnectionResponseDto
A wrapper containing the list of established social network connections for a given Constant Contact account
Fields
- connections? ConnectionDto[] - List of established social network connections for the account
constantcontact: ConnectionStatusDto
Data indicating the status of a social network connection's integration
Fields
- rateLimited? boolean - Whether this social network account or the Constant Contact application is currently rate-limited by the social network provider
- tokenIsValid? boolean - <code>true</code> if the token for this social network is currently valid and can be successfully used to fetch data from the network
- isActiveUser? boolean - A user is considered active if the user has any connected profiles for the social network account
- tokenHasScopes? boolean - Whether the token associated with this user's social account integration has the scopes necessary to use Constant Contact social functionality
- hasToken? boolean - <code>true</code> if the integration has an authorization token for this social network account
- 'error? string - A message indicating that there was an unexpected error accessing the social network account
- status? Signed32 - The status returned from the given network's API when retrieving the account. This is typically only set when <code>error</code> is set
constantcontact: ContactCampaignActivitiesSummary
Fields
- links? ReportingLinks -
- contactId string - Unique id of the contact that will have their activity summarized
- campaignActivities CampaignActivitySummary[] - A summary of all the actions for a contact
constantcontact: ContactCreateOrUpdateInput
Fields
- streetAddress? ContactCreateOrUpdateInputStreetAddress -
- customFields? CreateOrUpdateContactCustomField[] - The custom fields you want to add to the contact as an array of up to 50 custom field objects
- smsChannel? JmmlSmsChannel -
- lastName? string - The last name of the contact
- birthdayDay? int - The day value for the contact's birthday. Valid values are from 1 through 31. The <code>birthday_day</code> property is required if you use <code>birthday_month</code>
- emailAddress? string - 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
- listMemberships string[] - The contact lists you want to add the contact to as an array of up to 50 contact <code>list_id</code> values. You must include at least one <code>list_id</code>
- companyName? string - The name of the company where the contact works
- birthdayMonth? int - The month value for the contact's birthday. Valid values are from 1 through 12. The <code>birthday_month</code> property is required if you use <code>birthday_day</code>
- phoneNumber? string - The phone number for the contact
- firstName? string - The first name of the contact
- jobTitle? string - The job title of the contact
- anniversary? string - The anniversary date for the contact. For example, this value could be the date when the contact first became a customer of an organization in Constant 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
constantcontact: ContactCreateOrUpdateInputStreetAddress
Fields
- country? string - The name of the country for the contact's address
- city? string - The name of the city for the contact's address
- kind string - The type of street address for the contact. Valid values are <code>home</code>, <code>work</code>, or <code>other</code>
- street? string - The number and street of the contact's address
- state? string - The name of the state or province for the contact's address
- postalCode? string - The zip or postal code for the contact's address
constantcontact: ContactCreateOrUpdateResponse
Fields
- action? string - Identifies if the V3 API created a new contact or updated an existing contact
- contactId? string - The unique identifier for the contact that the V3 API created or updated
constantcontact: ContactCustomField
Custom fields allow Constant Contact users to add custom content to a contact that can be used to personalize emails in addition to the standard set of variables available for email personalization
Fields
- customFieldId string - The custom field's unique ID
- choiceIds? string[] - For <code>>multi_select</code> and <code>single_select</code> data types, the ID that uniquely identifies the choice associated with a the custom field
- value? string - The custom field value
constantcontact: ContactDelete
Fields
- contactIds? string[] - Specify up to 500 contacts by <code>contact_id</code> to delete; mutually exclusive with <code>list_ids</code>
- listIds? string[] - The contacts on the lists (up to 50) specified will be deleted; mutually exclusive with <code>contact_ids</code>
constantcontact: ContactDto
Fields
- lastUpdateTime? string - The time the event was last modified. ISO format
- emailAddress? string - The email address to use to when replying to email, as well as the email that receives SO notifications
- createTime? string - The create time of the event
- name string - The contact name to associate with the event
- phoneNumber? string - The phone number to associate with the event
- organizationName string - The organization name to associate with the event
- fromEmailAddress? string - The email address to use for sending confirmation emails
constantcontact: ContactList
Fields
- membershipCount? int - The total number of contacts that are members in a list. Does not apply to segment type lists
- listId string - Unique ID for the contact list
- updatedAt? string - Date and time that the list was last updated, in ISO-8601 format. System generated
- name string - The name given to the contact list
- description? string - Text describing the list
- createdAt? string - System generated date and time that the resource was created, in ISO-8601 format
- favorite boolean(default false) - Identifies whether or not the account has favorited the contact list
- deletedAt? string - If the list was deleted, this property shows the date and time it was deleted, in ISO-8601 format. System generated
constantcontact: ContactListArray
Fields
- listsCount? int - The total number of contact lists
- links? PagingLinks -
- lists? ContactList[] -
constantcontact: ContactListPutPost
Fields
- listId string - Unique ID for the contact list
- updatedAt? string - Date and time that the list was last updated, in ISO-8601 format. System generated
- name string - The name given to the contact list
- description? string - Text describing the list
- createdAt? string - System generated date and time that the resource was created, in ISO-8601 format
- favorite boolean(default false) - Identifies whether or not the account has favorited the contact list
- deletedAt? string - If the list was deleted, this property shows the date and time it was deleted, in ISO-8601 format. System generated
constantcontact: ContactOpenAndClickRates
The average click and open rates for a provided contact. The basic information provided is contact id, open rate, click rate, and emails included in the calculation
Fields
- averageOpenRate decimal - The average rate the contact opened emails sent to them
- averageClickRate decimal - The average rate the contact clicked on links in emails sent to them
- contactId string - The unique ID of the contact for which the report is being generated
- includedActivitiesCount Signed32 - The number of activities included in the calculation
constantcontact: ContactPostRequest
Fields
- notes? Note[] - An array of notes about the contact
- customFields? ContactCustomField[] - Array of up to 25 <code>custom_field</code> key value pairs
- streetAddresses? StreetAddressPut[] - Array of up to 3 street address subresources
- smsChannel? ContactSmsChannel -
- lastName? string - The last name of the contact
- createSource? string - Describes who added the contact; valid values are <code>Contact</code> or <code>Account</code>. Your integration must accurately identify <code>create_source</code> for compliance reasons; value is set on POST, and is read-only going forward
- birthdayDay? int - The day value for the contact's birthday. Valid values are from 1 through 31. The <code>birthday_day</code> property is required if you use <code>birthday_month</code>
- phoneNumbers? PhoneNumberPut[] - Array of up to 3 phone numbers subresources
- emailAddress? EmailAddressPost -
- listMemberships? string[] - Array of <code>list_id</code>s to which the contact is being subscribed, up to a maximum of 50
- companyName? string - The name of the company where the contact works
- birthdayMonth? int - The month value for the contact's birthday. Valid values are from 1 through 12. The <code>birthday_month</code> property is required if you use <code>birthday_day</code>
- taggings? string[] - Array of tags (<code>tag_id</code>) assigned to the contact, up to a maximum of 50
- firstName? string - The first name of the contact
- jobTitle? string - The job title of the contact
- anniversary? string - The anniversary date for the contact. For example, this value could be the date when the contact first became a customer of an organization in Constant 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
constantcontact: ContactPutRequest
Fields
- notes? Note[] - An array of notes about the contact listed by most recent note first
- customFields? ContactCustomField[] - Array of up to 25 <code>custom_field</code> subresources
- streetAddresses? StreetAddressPut[] - Array of up to 3 <code>street_addresses</code> subresources
- smsChannel? ContactSmsChannel -
- lastName? string - The contact's last name
- updateSource string - Identifies who last updated the contact; valid values are <code>Contact</code> or <code>Account</code>
- birthdayDay? int - Accepts values from 1-31; must be used with <code>birthday_month</code>
- phoneNumbers? PhoneNumberPut[] - Array of up to 3 <code>phone_numbers</code> subresources
- emailAddress? EmailAddressPut -
- listMemberships? string[] - Array of up to 50 <code>list_ids</code> to which the contact is subscribed
- companyName? string - Name of the company the contact works for
- birthdayMonth? int - Accepts values from 1-12; must be used with <code>birthday_day</code>
- taggings? string[] - Array of tags (<code>tag_id</code>) assigned to the contact, up to a maximum of 50
- firstName? string - The contact's first name
- jobTitle? string - The contact's job title
- anniversary? string - The anniversary date; Accepted formats are MM/DD/YYYY, M/D/YYYY, YYYY/MM/DD, YYYY/M/D, YYYY-MM-DD, YYYY-M-D, MM-DD-YYYY, M-D-YYYY
constantcontact: ContactResource
Use this endpoint to retrieve (GET), update (PUT), or DELETE an existing contact resource specified using the contact_id path parameter
Fields
- notes? Note[] - An array of notes about the contact listed by most recent note first
- customFields? ContactCustomField[] - Array of up to 25 <code>custom_field</code> subresources
- streetAddresses? StreetAddress[] - Array of up to 3 <code>street_addresses</code> subresources
- smsChannel? ContactResourceSmsChannel -
- lastName? string - The last name of the contact
- createdAt? string - System generated date and time that the resource was created, in ISO-8601 format
- contactId? string - Unique ID for each contact resource
- updateSource? string - Identifies who last updated the contact; valid values are <code>Contact</code> or <code>Account</code>
- deletedAt? string - For deleted contacts (<code>email_address</code> contains <code>opt_out_source</code> and <code>opt_out_date</code>), shows the date of deletion
- birthdayDay? int - The day value for the contact's birthday. Valid values are from 1 through 12. You must use this property with <code>birthday_day</code>
- createSource? string - Describes who added the contact; valid values are <code>Contact</code> or <code>Account</code>. Your integration must accurately identify <code>create_source</code> for compliance reasons; value is set when contact is created
- phoneNumbers? PhoneNumber[] - Array of up to 3 <code>phone_numbers</code> subresources
- emailAddress? EmailAddress -
- updatedAt? string - System generated date and time that the contact was last updated, in ISO-8601 format
- listMemberships? string[] - Array of up to 50 <code>list_ids</code> to which the contact is subscribed
- companyName? string - The name of the company where the contact works
- birthdayMonth? int - The month value for the contact's birthday. Valid values are from 1 through 12. You must use this property with <code>birthday_month</code>
- taggings? string[] - Array of tags (<code>tag_id</code>) assigned to the contact, up to a maximum of 50
- firstName? string - The first name of the contact
- jobTitle? string - The job title of the contact
- anniversary? string - The anniversary date for the contact. For example, this value could be the date when the contact first became a customer of an organization in Constant 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
constantcontact: ContactResourceSmsChannel
Includes SMS channel and consent details
Fields
- createSource? string - Identifies who added SMS details for the contact. The value is set when you create SMS details for the contact. Valid values are <code>Contact</code> or <code>Account</code>.
- countryCode? string - The two character ISO country code used for the SMS-capable phone. For example, the country code for the United States is <code>US</code>
- dialCode? string - The dial code used for the SMS-capable phone. For example, the dial code for the United States is <code>1</code>
- smsAddress? string - The phone number of the SMS-capable phone, which does not include the country code
- smsChannelId? string - The unique ID that identifies an SMS channel
- updateSource? string - Identifies who last updated SMS details for the contact. Valid values are Contact or Account
- smsChannelConsents? SmsChannelConsentDetails[] - Identifies SMS channel consent details such as the current permission status for the SMS channel and opt-in date
constantcontact: ContactResubscribeRequest
Fields
- listIds string[] - Array of list id values. Constant Contact adds the resubscribed contact to the contact lists you provide in the array
constantcontact: Contacts
Use this endpoint to retrieve (GET) a collection of existing contacts, or to create (POST) a new contact
Fields
- links? PagingLinks -
- contactsCount? int - Total number of contacts in the response
- contacts? ContactResource[] -
- status? string - If you use the <code>segment_id</code> query parameter to filter results based on a segment, this property indicates that the V3 API accepted your request and is still processing it
constantcontact: ContactsCounts
Fields
- explicit? int - Total number of contacts explicitly confirmed. Consent is obtained when you explicitly ask your potential contacts for permission to send the email (for example, using a sign-up form) and they agree. After you obtain express consent, it is good forever or until the contact opts out
- implicit? int - Total number of contacts implicitly confirmed. Consent is inferred based on actions, such as having an existing business relationship (making a purchase or donation, for example). In order to maintain implied consent to comply with CASL a contact must take a business action with you at least once every two years. Under CAN-Spam there is no need to maintain implied consent, it is assumed until the receiver indicates they no longer wish to receive messages
- total? int - Total number of contacts for the account
- unsubscribed? int - Total number of unsubscribed contacts. Consent is revoked when a contact has unsubscribed
- pending? int - Total number of contacts pending confirmation. Consent is requested and pending confirmation from the contact
- newSubscriber? int - Total number of newly subscribed contacts
constantcontact: ContactsExport
Export contact objects to a CSV file. By default, all contacts in the user's account are exported unless a filtering parameter is specified
Fields
- tagIds? string[] - Exports contacts assigned one or more of the tags (<code>tag_id</code>) specified. This property is mutually exclusive with all other filtering criteria
- exclude? ContactsExportExclude -
- newSubscriber? boolean - Set to <code>true</code> to only export contacts that subscribed within the last 30 days. Default setting is <code>false</code>. This property is mutually exclusive with all other filtering criteria except with either <code>list_ids</code> or <code>exclude</code>.
- segmentId? int - Specify the <code>segment_id</code> from which you want to export all contacts that meet the specified <code>segment_criteria</code>. You can only specify one <code>segment_id</code>. This property is mutually exclusive with all other filtering criteria
- fields? string[] - By default , all fields are returned. Use this array to only export specific contact fields. You must export <code>email_address</code> to successfully export <code>email_optin_source</code>, <code>email_optin_date</code>, <code>email_optout_source</code>, <code>email_optout_date</code>, or <code>email_optout_reason</code>
- contactIds? string[] - Exports up to 500 specific contacts. This property is mutually exclusive with all other filtering criteria except with<code>status</code>
- listIds? string[] - Exports all of the contacts inside of up to 50 contact lists. This property is mutually exclusive with all other filtering criteria except with either <code>status</code> or <code>exclude</code>
- status? string - Allows you to export only contacts that have a specific status value. This property is mutually exclusive with all other filtering criteria except with either <code>contact_ids</code> or <code>list_ids</code>
constantcontact: ContactsExportExclude
Fields
- contactIds? string[] - Excludes up to 50 specified contacts (<code>contact_id</code>) from being exported. This property is mutually exclusive with all other filtering criteria except with either <code>list_ids</code> or <code>new_subscriber</code>
constantcontact: ContactsJsonImport
Fields
- importData JsonImportContact[] - An array containing the contacts to import
- smsPermissionToSend? string - Specifies if the contact gave <code>explicit</code> SMS permission or if the SMS permission was not set (<code>not_set</code>). If
explicit, the <code>sms_consent_date</code> must be provided MISSING[]
- listIds string[] - Specify which contact lists you are adding all imported contacts to as an array of up to 50 contact <code>list_id</code> string values
constantcontact: ContactSmsChannel
Fields
- fullSmsAddress string - The SMS-capable phone number for the Contact, including the dial code
- smsChannelConsents ContactSmsChannelConsents[] - The consents for the SMS Channel
constantcontact: ContactSmsChannelConsents
Fields
- consentMediumDetails? string - Additional information about the consent such as the type of device used
- smsConsentPermission string - The current status of the SMS channel
- consentType string - The type of consent provided
constantcontact: ContactsUnsubscribeBody
Fields
- emailAddresses? string[] - Array of email addresses to unsubscribe
- optOutReason? string - Optional parameter to specify the reason for the unsubscribe
- deleteContacts boolean(default false) - Optional parameter to specify if the contact(s) should be soft-deleted as part of the unsubscribe
- updateSource "Account"|"Contact"|"System" - Required parameter to specify the update source performing the unsubscribe
- globalUnsubscribe boolean(default false) - Optional parameter to specify if the contact's email address should be unsubscribed from all partner child accounts. When specified only a single email address in the
email_addressesarray can be specified
constantcontact: ContactTrackingActivitiesPage
A page of tracking activities for a contact that can include sends, opens, clicks, bounces, opt-outs and forwards to a friend. If it exists, a link to the next page of tracking activities is provided
Fields
- links? ReportingLinks -
- trackingActivities? ContactTrackingActivity[] - The list of contact tracking activities in descending date order
constantcontact: ContactTrackingActivity
The base contact tracking activity representing sends, opt-outs and forwards to a friend. The basic information provided includes the campaign activity ID, tracking activity type, and time the tracking activity occurred
Fields
- trackingActivityType? string - The types of the tracking activities included in the request. For example, sends, opens, clicks, bounces, opt-outs, or forwards
- createdTime? string - The time the tracking activity occurred
- campaignActivityId string - The unique ID of the activity for an e-mail campaign
- contactId string - The contact ID
- campaignActivityName? string - The campaign activity name
constantcontact: ContactXref
The cross-referenced pair of V3 API list_id and V2 API sequence_id for a list. Response is sorted ascending by sequence_id
Fields
- sequenceId? string - The V2 API contact unique identifier
- contactId? string - The V3 API contact unique identifier
constantcontact: ContactXrefs
Fields
- xrefs? ContactXref[] - An array of cross-referenced V3 API <code>contact_id</code> and V2 API <code>sequence_id</code> values. Response is sorted ascending by <code>sequence_id</code>
constantcontact: CorrelationMetadataDto
Fields
- automationTemplateId? string - Automation template identifier
- automationFlowId? string - Automation flow identifier
- campaignId? string - Automation campaign identifier
constantcontact: CreateAutomationQueries
Represents the Queries record for the operation: createAutomation
Fields
- workflowName? string - Use this query parameter to provide a workflow name and override the default name
constantcontact: CreateDefaultEventQueries
Represents the Queries record for the operation: createDefaultEvent
Fields
- startTime? string - Event start time in ISO 8601 format. If not provided, defaults to a future date
- name? string - Name for the new event. If not provided, a default name will be generated
- endTime? string - Event end time in ISO 8601 format. If not provided, defaults to one hour after start time
- placeholderCampaignId? string - Placeholder campaign ID for the event
constantcontact: CreateOrUpdateContactCustomField
Fields
- customFieldId? string - The unique ID for the <code>custom_field</code>
- value? string - The value of the <code>custom_field</code>
constantcontact: CrossReference
Fields
- v2EmailCampaignId? string - Identifies an email campaign in the V2 API
- campaignActivityId? string - <p>Identifies a campaign activity in the V3 API. In the V3 API, each campaign contains one or more activities. Email type activities represent the detailed information in an email and contain properties like <code>from_email</code> and <code>from_name</code>. For more information, see <a href="/api_guide/v3_v2_email_campaign_deltas.html" target_"blank">V3 Campaign Resource Changes<a/>.<p>
- campaignId? string - <p>Identifies a campaign in the V3 API. In the V3 API, each campaign contains one or more activities. For more information, see <a href="/api_guide/v3_v2_email_campaign_deltas.html" target_"blank">V3 Email Campaign Resource Changes<a/>.<p>
constantcontact: CrossReferenceResponse
Fields
- xrefs? CrossReference[] - An array of objects that contain a <code>v2_email_campaign_id</code> cross-referenced with a V3 <code>campaign_id</code> and a V3 <code>campaign_activity_id</code> value
constantcontact: Customer
Fields
- physicalAddress? CustomerPhysicalAddress -
- website? string - The organization's website URL
- contactPhone? string - The account owner's contact phone number (up to 25 characters in length)
- lastName? string - The account owner's last name
- organizationName? string - The name of the organization that is associated with this account
- contactEmail? string - Email addresses that are associated with the Constant Contact account owner
- countryCode? string - The uppercase two-letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> representing the organization's country
- encodedAccountId? string - The readOnly encoded account ID that uniquely identifies the account
- encodedPartnerId? string - The encoded partner id that identifies which Constant Contact partner provisioned the account
- companyLogo? CompanyLogo -
- organizationPhone? string - The phone number of the organization that is associated with this account
- stateCode? string - The uppercase two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's state. This property is required if the <code>country_code</code> is US (United States)
- timeZoneId? string - The time zone that is automatically set based on the <code>state_code</code> setting; as defined in the IANA time-zone database (see http://www.iana.org/time-zones)
- firstName? string - The account owner's first name
constantcontact: CustomerPhysicalAddress
Fields
- countryCode string - The two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's country
- addressLine3? string - Line 3 of the organization's street address
- addressLine2? string - Line 2 of the organization's street address
- addressLine1 string - Line 1 of the organization's street address
- city string - The city where the organization is located
- stateName? string - Use if the state where the organization is physically located is not in the United States or Canada. If <code>country_code</code> is <code>US</code> or <code>CA</code>, exclude this property from the request body
- stateCode? string - The two letter ISO 3166-1 code for the organization's state and only used if the <code>country_code</code> is <code>US</code> or <code>CA</code>. If not, exclude this property from the request body
- postalCode? string - The postal code address (ZIP code) of the organization. This property is required if the <code>state_code</code> is <code>US</code> or <code>CA</code>, otherwise exclude this property from the request body
constantcontact: CustomerPut
Fields
- countryCode? string - The two-letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> representing the organization's country
- encodedAccountId? string - The read only encoded account ID that uniquely identifies the account
- website? string - The organization's website URL
- contactPhone? string - The account owner's contact phone number (up to 25 characters in length)
- organizationPhone? string - The phone number of the organization that is associated with this account
- lastName? string - The account owner's last name
- organizationName? string - The name of the organization that is associated with this account
- stateCode? string - The two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> used to specify the state to associate with the account. This property is required if the <code>country_code</code> is US (United States)
- timeZoneId? string - The time zone to use for the account; as defined in the IANA time-zone database (see http://www.iana.org/time-zones)
- firstName? string - The account owner's first name
- contactEmail? string - The confirmed email address that is associated with the account owner
constantcontact: CustomField
Custom fields details
Fields
- metadata? CustomFieldMetadata - Additional details about a custom field in JSON format
- updatedAt? string - System generated date and time that the resource was updated, in ISO-8601 format
- customFieldId? string - The system generated ID that uniquely identifies a <code>custom_field</code>
- name? string - The unique custom field name constructed from the label by replacing blanks with underscores
- createdAt? string - Date and time that the resource was created, in ISO-8601 format. System generated
- label string - The custom field name to display in the UI (free-form text)
- 'type string - The data value type the custom field accepts
- choices? CustomFieldChoice[] - Choices available for <code>single_select</code> and <code>multi_select</code> type custom fields. The maximum number of elements for <code>radio</code> or <code>checkbox</code> display types is 20. Maximum number of elements for a <code>dropdown</code> is 100
- version? int - For <code>datetime</code> data types, this is the version number associated with the custom field
constantcontact: CustomFieldChoice
Custom fields single_select and multi_select settings
Fields
- updatedAt? string - Date and time that the record was updated, in ISO-8601 format. System generated
- customFieldId? string - The ID that uniquely identifies a custom field
- displayOrder? int - Stores the order for displaying a list of choices
- createdAt? string - Date and time that the record was created, in ISO-8601 format. System generated
- choiceLabel? string - Label to display for the choice on the user interface
- choiceId? int - The ID that uniquely identifies the choice identifier
- deletedAt? string - Date the choice was deleted, in ISO-8601 format. System generated
constantcontact: CustomFieldChoicePutRequest
The single_select and multi_select custom field options
Fields
- displayOrder? int - Stores the order for displaying a list of choices
- choiceLabel? string - Label to display for the choice on the user interface
- choiceId? int - The ID that uniquely identifies the choice
constantcontact: CustomFieldChoiceRequest
The single_select and multi_select custom field options
Fields
- displayOrder? int - Stores the order for displaying a list of choices
- choiceLabel? string - Label to display for the choice on the user interface
constantcontact: CustomFieldId100
Fields
- customFieldIds string[] - The array of custom field IDs to delete
constantcontact: CustomFieldMetadata
Additional details about a custom field in JSON format
Fields
- displayType? string - Determines how Constant Contact renders a <code>single_select</code> or <code> multi_select</code> field
- allowNegative? boolean - For type <code>number</code>, determines if a value can be negative. By default, this value is false for the type <code>number</code>
- displayFormat? string - Specifies the display format for date fields in the user interface. If not specified for a date type field, defaults to <code>YYYY-MM-DD</code> format. Valid only for version 2 type dates (values are stored as actual dates to support date comparisons and validations)
- integer? boolean - For types <code>number</code> and <code>currency</code>, determines whether the custom field should store only whole numbers (integers) without decimal values. If the <code>integer</code> is set to <code>false</code>, the <code>decimal_places</code> must be between 1 and 4
- currencyCode? string - For type <code>currency</code>, specifies the three-letter currency code to assign
- decimalPlaces? int - For types <code>number</code> and <code>currency</code>, determines the number of decimal places possible in the value
constantcontact: CustomFieldPutRequest
Fields
- label? string - The custom field name to display in the UI (free-form text)
- choices? CustomFieldChoicePutRequest[] - Array of choices for custom fields of type: <code>single_select</code> or <code>multi_select</code>. Maximum number of elements for <code>checkbox</code> and <code>radio</code> display types is 20. Maximum number of elements for a <code>dropdown</code> is 100
constantcontact: CustomFieldRequest
Fields
- metadata? CustomFieldMetadata - Additional details about a custom field in JSON format
- label? string - The custom field name to display in the UI (free-form text)
- 'type? string - The type of data to store in the custom field
- choices? CustomFieldChoiceRequest[] - Array of choices for custom fields of type: <code>single_select</code> or <code>multi_select</code>. Maximum number of elements for <code>checkbox</code> and <code>radio</code> display types is 20. Maximum number of elements for a <code>dropdown</code> is 100
- version? int - Available if data type is <code>date</code>. Displays <code>1</code> if using legacy date fields where values are stored as strings. Displays <code>2</code> if using new date fields where values are stored as actual dates to support date comparisons and validations
constantcontact: CustomFields
Fields
- links? PagingLinks -
- customFields? CustomField[] -
constantcontact: DetailedRegistrationDto
Fields
- checkedInTickets? Signed32 - The total number of tickets assigned to a given <code>registration_id</code>
- displayPhysicalTickets? boolean - Determines if the physical tickets should display or not display
- registrationDate? string - The event registration date, in ISO format
- tickets? RegistrationTicketDto[] -
- registrationStatus? string - Provides the current registration status; <code>REGISTERED</code>, <code>PENDING</code>, <code>CANCELED</code>, <code>EXPIRED</code>, <code>IN_PROGRESS</code>, <code>FAILED</code>
- contact? SimpleFieldDto[] -
- registrationId? string - The unique ID used to identify an event registration
- eligibleCheckinTickets? Signed32 - The total number of tickets eligible for checkin
- contactId? string - The unique ID used to identify a contact
- checkinStatus? string - Provides the status of eligible checkin tickets
- orderSummary? OrderDetailsDto -
constantcontact: DidNotOpensTrackingActivitiesPage
Fields
- links? ReportingLinks -
- trackingActivities DidNotOpensTrackingActivity[] - Lists contacts that did not open the specified <code>campaign_activity_id</code>
constantcontact: DidNotOpensTrackingActivity
Fields
- trackingActivityType string - The type of tracking activity that is associated with this <code>campaign_activity_id</code> and used for reporting purposes
- createdTime string - The date and time that the contact was sent the email campaign activity
- campaignActivityId string - The ID that uniquely identifies an email campaign activity
- emailAddress string - The email address used to send the email campaign activity to a contact
- lastName? string - The last name of the contact
- contactId string - The ID that uniquely identifies a contact
- firstName? string - The first name of the contact
- deletedAt? string - If applicable, displays the date that the contact was deleted
constantcontact: EmailAddress
A contact subresource describing the contact's email address
Fields
- address string - The email address of the contact. The email address must be unique for each contact
- optOutDate? string - Date and time that the contact unsubscribed/opted-out of receiving email from the account, in ISO-8601 format. Displayed only if contact has been unsubscribed/opt-out. System generated
- updatedAt? string - Date and time that the email_address was last updated, in ISO-8601 format. System generated
- optInSource? string - Describes who opted-in the email_address; valid values are Contact or Account. Your integration must accurately identify <code>opt_in_source</code> for compliance reasons; value is set on POST, and is read-only going forward
- optInDate? string - Date and time that the email_address was opted-in to receive email from the account, in ISO-8601 format. System generated
- optOutReason? string - The reason, as provided by the contact, that they unsubscribed/opted-out of receiving email campaigns
- createdAt? string - Date and time that the email_address was created, in ISO-8601 format. System generated
- optOutSource? string - Describes the source of the unsubscribed/opt-out action: either Account or Contact. If the Contact opted-out, then the account cannot send any campaigns to this contact until the contact opts back in. If the Account, then the account can add the contact back to any lists and send to them. Displayed only if contact has been unsubscribed/opt-out
- confirmStatus? string - Indicates if the contact confirmed their email address after they subscribed to receive emails. Possible values: pending, confirmed, off
- permissionToSend? string - Identifies the type of permission that the Constant Contact account has to send email to the contact. Types of permission: explicit, implicit, not_set, pending_confirmation, temp_hold, unsubscribed
constantcontact: EmailAddressPost
The contact's email address and related properties
Fields
- address string - The contact's email address
- permissionToSend? string - Identifies the type of permission that the Constant Contact account has been granted to send email to the contact. Types of permission: explicit, implicit, not_set, pending_confirmation, temp_hold, unsubscribed
constantcontact: EmailAddressPut
The contact's email address and related properties
Fields
- address string - The email address of the contact. The email address must be unique for each contact
- optOutDate? string - Date and time that the contact unsubscribed/opted-out of receiving email from the account, in ISO-8601 format. Displayed only if contact has been unsubscribed/opt-out. System generated
- updatedAt? string - Date and time that the email_address was last updated, in ISO-8601 format. System generated
- optInDate? string - Date and time that the email_address was opted-in to receive email from the account, in ISO-8601 format. System generated
- optOutReason? string - The reason, as provided by the contact, that they unsubscribed/opted-out of receiving email campaigns
- createdAt? string - Date and time that the email_address was created, in ISO-8601 format. System generated
- optOutSource? string - Describes the source of the unsubscribed/opt-out action: either Account or Contact. If the Contact opted-out, then the account cannot send any campaigns to this contact until the contact opts back in. If the Account, then the account can add the contact back to any lists and send to them. Displayed only if contact has been unsubscribed/opt-out
- confirmStatus? string - Indicates if the contact confirmed their email address after they subscribed to receive emails. Possible values: pending, confirmed, off
- permissionToSend? string - Identifies the type of permission that the Constant Contact account has to send email to the contact. Types of permission: explicit, implicit, not_set, pending_confirmation, temp_hold, unsubscribed
constantcontact: EmailCampaign
Fields
- updatedAt? string - The system generated date and time showing when the campaign was last updated. This string is read only and is in ISO-8601 format
- name? string - The descriptive name the user provides to identify this campaign. Campaign names must be unique for each account ID
- createdAt? string - The system generated date and time that this email campaign was created. This string is readonly and is in ISO-8601 format
- currentStatus? string - The current status of the email campaign. Valid values are: <ul> <li>Draft — An email campaign that you have created but have not sent to contacts.</li> <li>Scheduled — An email campaign that you have scheduled for Constant Contact to send to contacts.</li> <li>Executing — An email campaign that Constant Contact is currently sending to contacts. Email campaign activities are only in this status briefly.</li> <li>Done — An email campaign that you successfully sent to contacts.</li> <li>Error — An email campaign activity that encountered an error.</li> <li>Removed — An email campaign that a user deleted. Users can view and restore deleted emails through the UI.</li> </ul>
- campaignActivities? ActivityReference[] - Lists the role and unique activity ID of each campaign activity that is associated with an Email Campaign
- 'type? string - Identifies the type of campaign that you select when creating the campaign. Newsletter and Custom Code email campaigns are the primary types
- campaignId? string - The unique ID used to identify the email campaign (UUID format)
- typeCode? int - The code used to identify the email campaign
type. <ul> <li> 1 (Default) </li> <li> 2 (Bulk Email) </li> <li> 10 (Newsletter) </li> <li> 11 (Announcement) </li> <li> 12 (Product/Service News) </li> <li> 14 (Business Letter) </li> <li> 15 (Card) </li> <li> 16 (Press release)</li> <li> 17 (Flyer) </li> <li> 18 (Feedback Request) </li> <li> 19 (Ratings and Reviews) </li> <li> 20 (Event Announcement) </li> <li> 21 (Simple Coupon) </li> <li> 22 (Sale Promotion) </li> <li> 23 (Product Promotion) </li> <li> 24 (Membership Drive) </li> <li> 25 (Fundraiser) </li> <li> 26 (Custom Code Email)</li> <li> 57 (A/B Test)</li> </ul>
constantcontact: EmailCampaignActivity
Fields
- campaignActivityId? string - Identifies a campaign activity in the V3 API
- role? string - The purpose of the individual campaign activity in the larger email campaign effort. Valid values are: <ul> <li>primary_email — The main email marketing campaign that you send to contacts. The <code>primary_email</code> contains the complete email content.</li> <li>permalink — A permanent link to a web accessible version of the <code>primary_email</code> content without any personalized email information. For example, permalinks do not contain any of the contact details that you add to the <code>primary_email</code> email content. </li> <li>resend — An email campaign that you resend to contacts that did not open the email campaign.</li> </ul> Constant Contact creates a <code>primary_email</code> and a <code>permalink</code> role campaign activity when you create an email campaign
- fromEmail string - The email "From Email" field for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to <code>/account/emails</code> to return a collection of account emails and their confirmation status
- subject string - The email "Subject" field for the email campaign activity
- contactListIds? string[] - The contacts that Constant Contact sends the email campaign activity to as an array of contact <code>list_id</code> values. You cannot use contact lists and segments at the same time in an email campaign activity
- fromName string - The email "From Name" field for the email campaign activity
- documentId? string - Identifies the email document used in an email editor (format_type 4) email campaign
- preheader? string - The email preheader for the email campaign activity. Only <code>format_type</code> 3, 4, and 5 email campaign activities use the preheader property
- formatType? Signed32 - Identifies the type of email format. Valid values are: <ul> <li>1 - A legacy custom code email created using the V2 API, the V3 API, or the legacy UI HTML editor.</li> <li>2 - An email created using the second generation email editor UI.</li> <li>3 - An email created using the third generation email editor UI. This email editor features an improved drag and drop UI and mobile responsiveness.</li> <li>4 - An email created using the fourth generation email editor UI.</li> <li>5 - A custom code email created using the V3 API or the new UI HTML editor.</li> </ul>
- replyToEmail string - The email "Reply To Email" field for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to <code>/account/emails</code> to return a collection of account emails and their confirmation status
- htmlContent? string - The HTML or XHTML content for the email campaign activity. Only <code>format_type</code> 1 and 5 (legacy custom code emails or modern custom code emails) can contain <code>html_content</code>
- segmentIds? int[] - The contacts that Constant Contact sends the email campaign activity to as an array containing a single <code>segment_id</code> value. Only <code>format_type</code> 3, 4, and 5 email campaign activities support segments. You cannot use contact lists and segments at the same time in an email campaign activity
- currentStatus? string - The current status of the email campaign activity. Valid values are: <ul> <li>DRAFT — An email campaign activity that you have created but have not sent to contacts.</li> <li>SCHEDULED — An email campaign activity that you have scheduled for Constant Contact to send to contacts.</li> <li>EXECUTING — An email campaign activity Constant Contact is currently sending to contacts. Email campaign activities are only in this status briefly.</li> <li>DONE — An email campaign activity that you successfully sent to contacts.</li> <li>ERROR — An email campaign activity that encountered an error.</li> <li>REMOVED — An email campaign that a user deleted. Users can view and restore deleted emails through the UI.</li> </ul>
- documentProperties? EmailCampaignActivityDocumentProperties -
- permalinkUrl? string - The permanent link to a web accessible version of the email campaign content without any personalized email information. The permalink URL becomes accessible after you send an email campaign to contacts
- campaignId? string - Identifies a campaign in the V3 API
- physicalAddressInFooter? EmailPhysicalAddress -
constantcontact: EmailCampaignActivityDocumentProperties
An object that contains optional properties for legacy format type emails (format_type 1 and 2). If you attempt to add a property that does apply to the email format_type, the API will ignore the property
Fields
- greetingSecondary? string - A fallback text string the campaign uses to greet the contact when the <code>greeting_name_type</code> is not available or set to <code>N</code>. This property applies only to <code>format_type</code> 1
- viewAsWebpageText? string - The text Constant Contact displays before the view as web page link at the top of the email. This property applies to <code>format_type</code> 1 and 2
- permissionReminder? string - The message text Constant Contact displays at the top of the email message to remind users that they are subscribed to an email list. This property applies to <code>format_type</code> 1 and 2
- textContent? string - Contains the text content that Constant Contact displays to contacts when their email client cannot display HTML email. If you do not specify text content, Constant Contact displays "Greetings!" as the text content. This property applies only to <code>format_type</code> 1
- letterFormat string(default "HTML") - Email message format. Valid values are <code>HTML</code> and <code>XHTML</code>. By default, the value is <code>HTML</code>. For more information, see the <a href="http://www.constantcontact.com/display_media.jsp?id=87" target="_blank">Advanced Editor User's Guide</a>. This property applies only to <code>format_type</code> 1. You cannot change this property after you create an email
- permissionReminderEnabled string(default "false") - If <code>true</code>, Constant Contact displays your <code>permission_reminder</code> message to contacts at top of the email. If <code>false</code>, Constant Contact does not display the message. By default, the value is <code>false</code>. This property applies to <code>format_type</code> 1 and 2
- forwardEmailLinkName? string - The text displayed as the name for the forward email link in the footer when a user forwards an email. This property applies to <code>format_type</code> 1 and 2
- subscribeLinkEnabled string(default "false") - If <code>true</code>, the email footer includes a link for subscribing to the list. If <code>false</code>, the message footer does not include a link for subscribing to the list. By default, the value is <code>false</code>. This property applies only to <code>format_type</code> 1
- subscribeLinkName? string - The text displayed as the name for the subscribe link in the email footer. This property applies only to <code>format_type</code> 1
- viewAsWebpageLinkName? string - The name of the link that users can click to view the email as a web page. This property applies to <code>format_type</code> 1 and 2
- forwardEmailLinkEnabled string(default "false") - If <code>true</code>, when the user forwards an email message the footer includes a link for subscribing to the list. If <code>false</code>, when a user forwards an email message the footer does not include a link for subscribing to the list. By default, the value is <code>false</code>. This property applies to <code>format_type</code> 1 and 2
- styleContent? string - Contains style sheet elements for XHTML letter format emails. This property applies only to <code>format_type</code> 1
- greetingSalutation? string - The greeting used in the email message. This property applies only to <code>format_type</code> 1
- greetingNameType string(default "N") - The type of name the campaign uses to greet the contact. Valid values are <code>F</code> (First Name), <code>L</code> (Last Name), <code>B</code> (First and Last Name), or <code>N</code> (No greeting). By default, the value is <code>N</code>. This property applies only to <code>format_type</code> 1
- viewAsWebpageEnabled string(default "false") - If <code>true</code>, Constant Contact displays the view as web page email message. If <code>false</code> Constant Contact does not display the message. By default, the value is <code>false</code>. This property applies to <code>format_type</code> 1 and 2
constantcontact: EmailCampaignActivityInput
Fields
- preheader? string - The email preheader for the email campaign activity. Contacts will view your preheader as a short summary that follows the subject line in their email client. Only <code>format_type</code> 3, 4, and 5 email campaign activities use the preheader property
- formatType Signed32 - The email format you are using to create the email campaign activity. The V3 API supports creating emails using <code>format_type</code> 4 (email editor) and 5 (custom code emails)
- replyToEmail string - The sender's email address to use if the contact replies to the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to <code>/account/emails</code> to return a collection of account emails and their confirmation status
- htmlContent string - The HTML content for the email campaign activity. Only <code>format_type</code> 5 (custom code emails) can contain <code>html_content</code>. When creating a <code>format_type</code> 5 custom code email, make sure that you include <code>[[trackingImage]]</code> in the <code><body></code> element of your HTML
- fromEmail string - The sender's email address to use for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to <code>/account/emails</code> to return a collection of account emails and their confirmation status
- subject string - The text to display in the subject line that describes the email campaign activity
- fromName string - The email sender's name to display for the email campaign activity
- physicalAddressInFooter? EmailPhysicalAddress -
constantcontact: EmailCampaignActivityPreview
Fields
- preheader? string - The email preheader for the email campaign activity. Only <code>format_type</code> 3, 4, and 5 email campaign activities use the preheader property
- replyToEmail? string - The email "Reply To Email" field for the email campaign activity
- campaignActivityId? string - The unique ID for an email campaign activity
- fromEmail? string - The "from email" email header for the email campaign activity
- subject? string - The email "Subject" field for the email campaign activity
- previewHtmlContent? string - An HTML preview of the email campaign activity
- previewTextContent? string - A plain text preview of the email campaign activity
- fromName? string - The "from name" email header for the email campaign activity
constantcontact: EmailCampaignComplete
Fields
- name string - The unique and descriptive name that you specify for the email campaign
- emailCampaignActivities EmailCampaignActivityInput[] - The content of the email campaign as an array that contains a single email campaign activity object
constantcontact: EmailCampaignName
Fields
- name string - The updated email campaign name. The email campaign name must be unique
constantcontact: EmailCampaigns
Fields
- updatedAt? string - The system generated date and time showing when the campaign was last updated. This string is read only and is in ISO-8601 format
- name? string - The descriptive name the user provides to identify this campaign. Campaign names must be unique for each account ID
- createdAt? string - The system generated date and time that this email campaign was created. This string is readonly and is in ISO-8601 format
- currentStatus? string - The current status of the email campaign. Valid values are: <ul> <li>Draft — An email campaign that you have created but have not sent to contacts.</li> <li>Scheduled — An email campaign that you have scheduled for Constant Contact to send to contacts.</li> <li>Executing — An email campaign that Constant Contact is currently sending to contacts. Email campaign activities are only in this status briefly.</li> <li>Done — An email campaign that you successfully sent to contacts.</li> <li>Error — An email campaign activity that encountered an error.</li> <li>Removed — An email campaign that a user deleted. Users can view and restore deleted emails through the UI.</li> </ul>
- 'type? string - Identifies the type of campaign that you select when creating the campaign. Newsletter and Custom Code email campaigns are the primary types
- campaignId? string - The unique ID used to identify the email campaign (UUID format)
- typeCode? int - The code used to identify the email campaign
type. <ul> <li> 1 (Default) </li> <li> 2 (Bulk Email) </li> <li> 10 (Newsletter) </li> <li> 11 (Announcement) </li> <li> 12 (Product/Service News) </li> <li> 14 (Business Letter) </li> <li> 15 (Card) </li> <li> 16 (Press release)</li> <li> 17 (Flyer) </li> <li> 18 (Feedback Request) </li> <li> 19 (Ratings and Reviews) </li> <li> 20 (Event Announcement) </li> <li> 21 (Simple Coupon) </li> <li> 22 (Sale Promotion) </li> <li> 23 (Product Promotion) </li> <li> 24 (Membership Drive) </li> <li> 25 (Fundraiser) </li> <li> 26 (Custom Code Email)</li> <li> 57 (A/B Test)</li> </ul>
constantcontact: EmailLinkClickCount
Fields
- listId? string - If the link uses the click segmentation feature, this property contains the contact list linked with the <code>list_action</code> property
- uniqueClicks? Signed32 - The number of unique contacts that clicked the link
- linkTag? string - Link tags are not currently available in email campaigns. By default, this method combines results for duplicate link URLs. Link tags will allow users to get a separate link click report for each unique <code>link_tag</code> value they use, even if URLs are not unique
- listAction? string - If the link uses the click segmentation feature, this property contains the action that contacts trigger when they click the link. Currently the only available action is <code>add</code>, which adds contacts that click the link to a contact list
- linkUrl? string - The URL of a link in an email campaign activity. This URL is not normalized and appears the same as the URL in the email campaign activity
- urlId? string - The ID for a unique link URL in an email campaign activity
constantcontact: EmailLinks
Fields
- campaignActivityId? string - The unique ID for an email campaign activity
- linkClickCounts? EmailLinkClickCount[] - An array of objects that contain the contact click count and link metadata for each unique link URL in an email campaign activity. By default, this method combines results for duplicate link URLs
constantcontact: EmailPhysicalAddress
Fields
- countryCode string - The uppercase two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's country
- addressLine3? string - Line 3 of the organization's street address
- addressLine2? string - Line 2 of the organization's street address
- addressLine1 string - Line 1 of the organization's street address
- city? string - The city where the organization sending the email campaign is located
- stateName? string - The full state name for a <code>state_code</code> that is inside the United States. Automatically generated using the <code>state_code</code>
- countryName? string - The full name of the country where the organization sending the email is located. Automatically generated using the <code>country_code</code>
- organizationName string - The name of the organization that is sending the email campaign
- postalCode? string - The postal code address (ZIP code) of the organization
- stateCode? string - The uppercase two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's state. This property is required if the <code>country_code</code> is US (United States)
- stateNonUsName? string - The full state name for a <code>state_code</code> that is outside the United States. This property is not read only
- addressOptional? string - An optional address field for the organization. Only <code>format_type</code> 3, 4, and 5 can use this property
constantcontact: EmailScheduleInput
Fields
- scheduledDate string - The date when Constant Contact will send the email campaign activity to contacts in ISO-8601 format. For example, <code>2022-05-17</code> and <code>2022-05-17T16:37:59.091Z</code> are valid dates. Use <code>"0"</code> as the date to have Constant Contact immediately send the email campaign activity to contacts
constantcontact: EmailScheduleResponseInner
Fields
- scheduledDate? string - The date when Constant Contact will send the email campaign activity to contacts in ISO-8601 format. For example, <code>2022-05-17</code> and <code>2022-05-17T16:37:59.091Z</code> are valid dates
constantcontact: EmailSendHistoryInner
Fields
- reasonCode? Signed32 - The reason why the send attempt completed or encountered an error. This method returns <code>0</code> if Constant Contact successfully sent the email campaign activity to contacts. Possible <code>reason_code</code> values are: <ul> <li>0 — Constant Contact successfully sent the email to contacts.</li> <li>1 — An error occurred when sending this email. Try scheduling it again, or contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a>.</li> <li>2 — We were unable to send the email. Please contact our <a href='http://knowledgebase.constantcontact.com/articles/KnowledgeBase/5782-contact-an-account-review-and-deliverability-specialist' target='_blank'>Account Review Team</a> for more information.</li> <li>3 — This Constant Contact account cannot currently send emails. This can be due to billing or product expiration.</li> <li>4 — You're not able to send the email to that many contacts. Remove contacts from the contact lists you are using or select a list with fewer contacts.</li> <li>5 — The email is currently in staging. For more information, see the <a href='http://knowledgebase.constantcontact.com/articles/KnowledgeBase/7402-email-staging' target='_blank>Email Staging Knowledge Base article</a>.</li> <li>6 — Constant Contact was unable to finish sending this email to all of the contacts on your list. Please contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a> for more information.</li> <li>7 — The email contains invalid images. This can be caused when one or more images in the email are longer available in your image library.</li> <li>8 — The email contains a link URL that exceeds 1005 characters.</li> <li>9 — Constant Contact was unable to verify your authenticated Sender address. Please contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a> for more information.</li> <li>10 — Constant Contact was unable to verify your authenticated Sender address. Please contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a> for more information.</li> <li>11 — This Constant Contact account cannot send survey invitations.</li> <li>12 — Constant Contact attempted to send the email, but there were no eligible contacts to send it to. This can be caused by an invalid contact list, a contact list with no contacts, or a contact list with no new contacts during a resend. This method displays <code>reason_code</code> 12 as a send attempt with a <code>send_status</code> of COMPLETED and a <code>count</code> of 0.</li> </ul>
- sendId? Signed32 - Uniquely identifies each send history object using the number of times that you sent the email campaign activity as a sequence starting at <code>1</code>. For example, when you send a specific email campaign activity twice this method returns an object with a <code>send_id</code> of 1 for the first send and an object with a <code>send_id</code> of 2 for the second send
- segmentIds? int[] - The contact segments that Constant Contact sent the email campaign activity to as an array of <code>segment_id</code> integers
- contactListIds? string[] - The contacts lists that Constant Contact sent email campaign activity to as an array of contact <code>list_id</code> strings
- count? int - The number of contacts that Constant Contact sent this email campaign activity to. This property is specific to each send history object. When you resend an email campaign activity, Constant Contact only sends it to new contacts in the contact lists or segments you are using
- sendStatus? string - The send status for the email campaign activity. Valid values are: <ul> <li><code>COMPLETED</code>: Constant Contact successfully sent the email campaign activity.</li> <li><code>ERRORED</code>: Constant Contact encountered an error when sending the email campaign activity.<li> </ul>
- runDate? string - The system generated date and time that Constant Contact sent the email campaign activity to contacts in ISO-8601 format
constantcontact: EmailsLink
Fields
- href? string -
constantcontact: EmailsPagingLinks
Fields
- next? EmailsLink -
constantcontact: EmailTestSendInput
Fields
- emailAddresses string[] - The recipients of the test email as an array of email address strings. You can send a test email to up to 5 different email addresses at a time
- personalMessage? string - A personal message for the recipients of the test email. Constant Contact displays this message before the email campaign activity content
constantcontact: EventCopyRequestDto
Request payload for copying an event
Fields
- sourceCampaignActivities? string[] - Optional array of campaign activity UUIDs to copy. If not provided, all activities are copied
- targetEventName string - Name for the copied event. Must be unique for the account
constantcontact: EventDto
Fields
- eso? string - The encrypted SOId
- displayTimeZoneFlag? boolean - Display the time zone on the registration form and registration confirmation message
- registrationUrl? string - The event registration URL
- eventSettings? EventSettingsDto -
- cancelledTime? string - The time the event was cancelled, in ISO format. Read-only
- displayEndTimeFlag? boolean - Display or hide the event end time on the registration form and registration confirmation message
- description string - Provides the event description
- defaultTrack TrackDto -
- title string - The title for the event. The title does not have to be unique for an account
- failedCampaignActivities? string[] - List of failed campaign activities
- eventEnd string - The date the event ends
- eventType string - Identifies the event type
- notifyOwnerOnReg? boolean - If
true, sends an email to the event owner when a registration is made
- eventCode? string - The short code to use for the event
- contact? ContactDto -
- timeZoneAbbreviation? string - The abbreviation to use to indicate the time zone where the event takes place
- displayOnCalendarFlag? boolean - Display the event on the Event Calendar
- campaignId string - The system assigned ID that uniquely identifies the event and is identical to the
event_id
- address? AddressDto -
- createTime? string - The time the event was created, in ISO format. Read-only
- eventPromotions? EventPromotionDto[] - List of event promotions
- timeZone string - The time zone where the event takes place
- eventMetadata? EventMetaDataDto -
- locationType string - Specifies if the event is physical and/or virtual, or to be determined
- activeTime? string - The time the event was published, in ISO format
- lastUpdateTime? string - The date and time the event was last modified
- displayContactFlag? boolean - Display or hide event contact information on the registration form and registration confirmation message
- eventStart string - The date the event starts
- eventId? string - The ID that uniquely identifies the event
- currencyType? string - The accepted currency for payments. Required for events collecting payments ['AUD','BRL','CAD','CHF','CZK','DKK','EUR','GBP','HKD','HUF','ILS','JPY','MXN','MYR','NOK','NZD','PHP','PLN','RUB','SEK','SGD','THB','TRY','TWD','USD']
- onlineMeeting? OnlineMeetingDto -
- eventWidgetUrl? string - The event widget URL
- name string - The name of the event, has to be unique for the account
- deletedTime? string - The time the event was deleted, in ISO format. Read-only
- eventCalendarUrl? string - The event calendar URL
- status? string - Specifies the event's current status
constantcontact: EventListingDto
Provides information about the event listing
Fields
- registrationUrl? string - The URL for event registration
- address? AddressDto -
- createTime? string - The create time of the event in UTC format
- endTime? string - The end time of the event in UTC format
- timeZoneType? string - The type of time zone
- description? string - The description of the event
- title? string - The title of the event
- locationType? string - Specifies if this is a physical or virtual event (of both), or if the location is to be specified in the future
- startTime? string - The start time of the event in UTC format
- eventId? string - The unique identifier for the event
- eventType? string - Use to specify the type of event
- eventRegistrationSummaryMetrics? EventRegistrationSummaryMetricDto -
- name? string - The name of the event
- status? string - The current status of the event
constantcontact: EventMediaAssetDto
Fields
- lastUpdateTime? string - Last time the media was modified. ISO format
- externalUrl? string - The event media URL
- createTime? string - Create time of the event media. ISO format
- internalId? string - The internal ID for the event media
- mediaType? string - Identifies the media type
- externalId? string - The external ID to associate with the event media
constantcontact: EventMetaDataDto
Additional information related to event
Fields
- itemsEnabled? boolean - Specifies if the items are enabled for the event
- paidEvent? boolean - Specifies if the event requires payment
- promoCodesEnabled? boolean - Specifies if promotion codes are enabled for the event
constantcontact: EventPromotionDto
Represents a promotion associated with an event
Fields
- default? boolean - Whether this is the default promotion
- campaignActivityId? string - The unique identifier for the campaign activity
- extId? string - The external identifier
- assocActivitySubType? string - The type of associated activity
- documentId? string - The unique identifier for the document
constantcontact: EventRegistrationSummaryMetricDto
Fields
- itemSold? Signed32 - The total number of items sold for the event
- registrationCount? Signed32 - The total number of registrants for the event
- ticketSold? Signed32 - The total number of tickets sold for the event
constantcontact: EventSettingsDto
Fields
- eventRequiresPayments? boolean - Specifies if the event is configured to require payment
- paymentConfigured? boolean - Specifies if payment is configured for the event
- ticketConfigured? boolean - Specifies if ticketing is configured for the event
- promoCodeConfigured? boolean - Specifies if promo code is configured for the event
- itemConfigured? boolean - Specifies if items exist for the event
- onlinePaymentConfigured? boolean - Specifies if online payment is configured for the event
constantcontact: ForwardsTrackingActivitiesPage
Fields
- links? ReportingLinks -
- trackingActivities ForwardsTrackingActivity[] - The list of contacts that forwarded the specified email campaign activity.
constantcontact: ForwardsTrackingActivity
Fields
- trackingActivityType string - The type of report tracking activity that is associated with the specified <code>campaign_activity_id</code>
- createdTime string - The time that the contact forwarded the email campaign activity
- campaignActivityId string - The ID that uniquely identifies the email campaign activity
- emailAddress string - The contact's email address
- lastName? string - The last name of the contact
- contactId string - The ID that uniquely identifies a contact
- firstName? string - The first name of the contact
- deletedAt? string - If applicable, displays the date that the contact was deleted
constantcontact: GetAccountSummaryQueries
Represents the Queries record for the operation: getAccountSummary
Fields
- extraFields? "physical_address"|"company_logo" - Use the
extra_fieldsquery parameter to include thephysical_addressand/orcompany_logodetails in the response body. Use a comma separated list to include both (physical_address, company logo)
constantcontact: GetCampaignPerformanceStatsQueries
Represents the Queries record for the operation: getCampaignPerformanceStats
Fields
- filter string(default "adjusted_timestamp") - Filter campaigns by adjusted_timestamp (default) or start_at
- endAt? string - The date range end in ISO 8601 format (e.g. '2016-01-27T21:56:37.011Z')
- count? string - Number of campaign stats to return in a single request
- startAt? string - The date range start in ISO 8601 format (e.g. '2016-01-27T21:56:37.011Z')
constantcontact: GetContactActivitySummaryQueries
Represents the Queries record for the operation: getContactActivitySummary
Fields
- 'start string - The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500
- end string - The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500
constantcontact: GetContactConsentCountsQueries
Represents the Queries record for the operation: getContactConsentCounts
Fields
- include? "new_subscriber" - Use to return the total number of contacts that subscribed within the last 30 days in the results
constantcontact: GetContactOpenClickRateQueries
Represents the Queries record for the operation: getContactOpenClickRate
Fields
- 'start string - The starting date, in ISO 8601 format, to use to get campaigns. For example: 2019-01-01T00:00:00-0500
- end string - The ending date, in ISO 8601 format, to use to get campaigns. For example: 2019-12-01T00:00:00-0500
constantcontact: GetContactQueries
Represents the Queries record for the operation: getContact
Fields
- include? "custom_fields"|"list_memberships"|"phone_numbers"|"street_addresses"|"taggings"|"notes" - Use
includeto specify which contact sub-resources to include in the response. Use a comma to separate multiple sub-resources. Valid values:custom_fields,list_memberships,phone_numbers,street_addresses,notes, andtaggings
constantcontact: GetContactTrackingQueries
Represents the Queries record for the operation: getContactTracking
Fields
- trackingActivitiesList? string - Specify one or more tracking activity types to include as a comma-delimited string. The
tracking_activities_listandtracking_activities_typequery parameters are mutually exclusive
- trackingActivityType? string[] - Specify one or more tracking activity types to include as an array. The
tracking_activities_listandtracking_activities_typequery parameters are mutually exclusive
- includeCampaignActivityNames boolean(default true) - Default (
true) returns campaign activity names in the results. Not including campaign activity names in the results (false), is more efficient
- 'limit string(default "100") - The number of tracking activities to return in a single page. Valid values are 1 to 100. Default is 100
constantcontact: GetEmailBouncesQueries
Represents the Queries record for the operation: getEmailBounces
Fields
- 'limit string(default "500") - The number of tracking activities to return on a page
- bounceCode? ("B"|"D"|"F"|"S"|"V"|"X"|"Z")[] - To return results for a specific bounce code, select the
bounce_codefrom the drop-down list. To return results for multiple codes, repeat the bounce code parameter for each. For example, to return results for bounce codesBandDusebounce_code=B&bounce_code=D
constantcontact: GetEmailCampaignActivityQueries
Represents the Queries record for the operation: getEmailCampaignActivity
Fields
- include? "physical_address_in_footer"|"permalink_url"|"html_content"|"document_properties" - Use the
includequery parameter to enter a comma separated list of additional email campaign activity properties for the V3 API to return. Valid values arephysical_address_in_footer,permalink_url,html_content, anddocument_properties
constantcontact: GetEmailCampaignSummariesQueries
Represents the Queries record for the operation: getEmailCampaignSummaries
Fields
- 'limit string(default "50") - Use the
limitquery parameter to limit the number of email campaign summaries to return on a single page. The default is50and the maximum is500per page
constantcontact: GetEmailClicksQueries
Represents the Queries record for the operation: getEmailClicks
Fields
- 'limit string(default "500") - The number of tracking activities to return on a page
- urlId? int - The ID that uniquely identifies a single link URL for which you want to get a clicks report
constantcontact: GetEmailDidNotOpensQueries
Represents the Queries record for the operation: getEmailDidNotOpens
Fields
- 'limit string(default "500") - The number of tracking activities to return on a page
constantcontact: GetEmailForwardsQueries
Represents the Queries record for the operation: getEmailForwards
Fields
- 'limit string(default "500") - The number of tracking activities to return on a page
constantcontact: GetEmailLinksReportQueries
Represents the Queries record for the operation: getEmailLinksReport
Fields
- noClicks boolean(default false) - Set this query parameter to
trueto return details for links that were not clicked in the response results
constantcontact: GetEmailOpensQueries
Represents the Queries record for the operation: getEmailOpens
Fields
- 'limit string(default "500") - The number of tracking activities to return on a page
constantcontact: GetEmailOptoutsQueries
Represents the Queries record for the operation: getEmailOptouts
Fields
- 'limit string(default "500") - The number of tracking activities to return on a page
constantcontact: GetEmailSendsQueries
Represents the Queries record for the operation: getEmailSends
Fields
- 'limit string(default "500") - The number of tracking activities to return on a page
constantcontact: GetEmailUniqueOpensQueries
Represents the Queries record for the operation: getEmailUniqueOpens
Fields
- 'limit string(default "500") - The number of tracking activities to return on a page
constantcontact: GetEventQueries
Represents the Queries record for the operation: getEvent
Fields
- include? boolean - Use to include (
true) or exclude (false) event setting properties in the results
constantcontact: GetLandingPageContactOpensQueries
Represents the Queries record for the operation: getLandingPageContactOpens
Fields
- contactsFilter? string - 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
- 'limit string(default "50") - Use to limit the number of contact tracking activities to return on a single page. The default is
50and the maximum is500per page
constantcontact: GetLandingPageUniqueContactAddsQueries
Represents the Queries record for the operation: getLandingPageUniqueContactAdds
Fields
- contactsFilter? string - 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
- 'limit string(default "50") - Use to limit the number of contact tracking activities to return on a single page. The default is
50and the maximum is500per page
constantcontact: GetLandingPageUniqueContactClicksQueries
Represents the Queries record for the operation: getLandingPageUniqueContactClicks
Fields
- contactsFilter? string - 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
- 'limit string(default "50") - Use to limit the number of contact tracking activities to return on a single page. The default is
50and the maximum is500per page
constantcontact: GetLandingPageUniqueContactOpensQueries
Represents the Queries record for the operation: getLandingPageUniqueContactOpens
Fields
- contactsFilter? string - 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
- 'limit string(default "50") - Use to limit the number of contact tracking activities to return on a single page. The default is
50and the maximum is500per page
constantcontact: GetLandingPageUniqueContactSmsOptInsQueries
Represents the Queries record for the operation: getLandingPageUniqueContactSmsOptIns
Fields
- contactsFilter? string - 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
- 'limit string(default "50") - Use to limit the number of contact tracking activities to return on a single page. The default is
50and the maximum is500per page
constantcontact: GetLandingPageUniqueContactUpdatesQueries
Represents the Queries record for the operation: getLandingPageUniqueContactUpdates
Fields
- contactsFilter? string - 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
- 'limit string(default "50") - Use to limit the number of contact tracking activities to return on a single page. The default is
50and the maximum is500per page
constantcontact: GetListQueries
Represents the Queries record for the operation: getList
Fields
- includeMembershipCount? "all"|"active" - Returns the total number of contacts per list that meet your selection criteria. Set the
include_membership_counttoactive, to count only active contacts, orallto include all contacts in the count
constantcontact: GetSmsCampaignSummariesQueries
Represents the Queries record for the operation: getSmsCampaignSummaries
Fields
- endAt? string - Use to limit the results to include SMS campaign summary details for SMS campaigns sent on or before the
end_atdate you specify. ISO 8601 format
- 'limit string(default "50") - Use to limit the number of results to return on a single page (from 1 to 50). The default setting is 50
- startAt string - Use to limit the results to include SMS campaign summary details for SMS campaigns sent on or after the required
start_atdate you specify. ISO 8601 format
constantcontact: GetTagQueries
Represents the Queries record for the operation: getTag
Fields
- includeCount boolean(default false) - Use to include (
true) or exclude (false) the total number of tagged contacts (contacts_count) from the results
constantcontact: HashtagGroupDto
Represents a named collection of hashtags that can be reused when creating social posts
Fields
- hashtagGroupId? string - Unique identifier for this hashtag group. Automatically generated on creation and returned in all responses
- hashtagGroupName string - The human-readable name for this group. <p>This name will be sanitized before saving, which may include trimming whitespace, truncation, and/or removing invalid characters. If the sanitized name results in a blank string, it will not be able to be saved, and any create or update operation will fail.</p><p>The name is currently limited to a maximum of 150 characters, but the effective length may be shorter, depending on whether special characters (such as emoji) are used.</p>
- hashtagNames string[] - The list of hashtag names for this group. <p>Hashtag <em>names</em> do not include any leading '#' character. They can only consist of alphanumeric characters and '_' (underscore). The hashtag name cannot begin or end with an underscore. Hashtag names may begin with a letter or a number, and may consist of only numbers. Hashtag names are currently limited to a maximum of 30 characters.</p><p>The list order is preserved. If duplicates exist, they will be removed when saving, and the first occurrence will retain its position.</p>
constantcontact: HeadersObject
Fields
- headerValue? string - The value of the header
- headerKey? string - The name of the header
constantcontact: HistoryDetails
Additional details about the SMS consent actions (opt-in, opt-out) in JSON format. The consent_action_type and the method used to add or update a contacts SMS details determines which properties are returned in the results
Fields
- sourceConsentTimestamp? string - The time that SMS consent was last updated
- advertisedFrequency? int - If applicable, the advertising numeric component used to advertise to the contact.. For example, if <code>advertised_frequency</code> is set to <code> 2</code> , and <code>advertised_interval</code> is set to <code>M</code>, the contact receives advertisements twice a month
- consentMediumType? string - The code representing the medium used to provide consent. Medium types include mobile device (<code>MD</code>). lead generation form(<code>LF</code>), deactivation by carrier(<code>CD</code>), import_file:(<code>FI</code>), and system (<code>SY</code>)
- advertisedInterval? string - If applicable, the interval component used to advertise to the contact. For example, if <code>advertised_frequency</code> is set to <code> 2</code> , and <code>advertised_interval</code> is set to <code>M</code>, the contact receives advertisements twice a month
- consentActionTime? string - The date and time that SMS engagement data was last updated, in ISO-8601 format. System generated
- consentActionType? string - The type of consent action provided
- sourceSmsNumber? string - If applicable, the SMS consent number associated with the source
- state? string - The code representing the consent state, including <code>E</code> for optin and <code>O</code> for Optin
- 'source? string - The code representing the consent source type, including <code>A</code> for Account, <code>C</code> for Contact, and <code>S</code>' for System
- consentType? string - The type of SMS consent used
constantcontact: Href
Fields
- href? string -
constantcontact: ImageDto
An image to include in a social post
Fields
- imageId? string - Unique identifier for this image. Generated by the server on creation
- url string - The URL of the image. Each component of the URL must be appropriately encoded to avoid illegal characters
constantcontact: ItemDto
Fields
- quantityRemaining? Signed32 - The total number of items still available
- createTime? string - The create time of the event is ISO format
- limitPerOrder? Signed32 - Limits the number of items per order
- itemId? string - The unique identifier for the item
- displayOrder? Signed32 - The order in which to display an item
- endTime? string - The time that the item become unavailable
- description? string - The description of the item
- pausedFlag? boolean - Specifies if the item is currently paused from sales
- mediaUrl? string - The URL to associate with the media
- hiddenFlag? boolean - Specifies if the item is hidden from customers
- quantitySold? Signed32 - The total number of items sold
- lastUpdateTime? string - Last modification time of the event
- startTime? string - The start time when the item becomes available
- quantityTotal? Signed32 - The total number of items available
- statusLabels? StatusDisplayLabelDto[] -
- price? decimal - The price per item
- name string - The name of the item
- timeLimitFlag? boolean - Specifies if the item has time-based availability
- deletableFlag? boolean - Specifies if the item can be deleted
- showRemainingFlag? boolean - Set to display or not to display the number of remaining items to customers
- mediaInternalId? string - The internal identifier for the item's image
- attributes? AttributeDto[] -
- deletedTime? string - The time when the item was deleted
constantcontact: ItemSummaryDto
Summary information for an item
Fields
- itemId? string - The unique identifier for the item
- displayItemOnPromoRedemption? boolean - Specifies if the item on promo code redemption displays
- associated? boolean - Specifies if the item is associated with the promo code
- name string - The name of the item
- hiddenFlag? boolean - Specifies if the item is hidden
constantcontact: JmmlSmsChannel
The contact's SMS details
Fields
- countryCode string - The two-digit code that identifies the country
- dialCode string - The dial code the country uses. For example, use <code>1</code> for the United States dial code
- smsAddress string - The contact's SMS-capable phone number, excluding the country code
- smsChannelConsents JmmlSmsChannelConsents[] - The consents provided for the SMS Channel
constantcontact: JmmlSmsChannelConsents
Fields
- consentMediumDetails string - Additional information for the consent
- advertisedFrequency? int - The numeric component used to indicate how often to send advertising. For example, <code>1</code> indicates once. Use with <code>advertised_internal</code> property to indicate when on the calender to send it. For example, to send once (<code>1</code>) daily, weekly, or monthly
- consentMediumType string - A code representing where the consent was retrieved
- advertisedInterval? string - The calender interval used to indicate when advertising is sent. For example <code>weekly</code>
- smsConsentPermission string - The current consent status of the SMS Channel
- consentMediumUrl string - The URL for which the consent was gathered, such as a landing page
- consentType string - The type of consent provided
constantcontact: JsonImportContact
Fields
- country? string - The name of the primary country where the contact is located. Use this field to add the default kind of country to the imported contact's street address. The default <code>kind</code> is <code>home</code>
- homeCountry? string - The name of the country where the contact lives
- city? string - The name of the primary city for the contact. Use this field to add the default kind of city to the imported contact's home address. The default <code>kind</code> is <code>home</code>
- cfCustomFieldName? string - The name of this property is dynamic based on the custom fields you want to import. Use a key-value pair where the key is an existing custom field name prefixed with <code>cf:</code>, and the value is a custom field string value. For example, if you have a custom field named <code>first_name</code> you can use <code>"cf:first_name":"Joe"</code>. Each contact can contain up to 25 different custom fields
- workPhone? string - The work phone number for the contact
- homeZip? string - The zip or postal code associated with the contact's home address
- birthdayDay? int - The day value for the contact's birthday. Valid values are from 1 through 31. The <code>birthday_day</code> property is required if you use <code>birthday_month</code>
- workStreet2? string - Line two of the work street address for the contact. This value is automatically appended to the <code>work_street</code> value
- homeStreet2? string - Line two of the home street address for the contact. This value is automatically appended to the <code>home_street</code> value
- workState? string - The name of the state or province where the contact works
- mobilePhone? string - The mobile phone number for the contact
- street? string - Line one of the primary street address for the contact. Use this field to add the default kind of street to the imported contact's street address. The default <code>kind</code> is <code>home</code>. which maps to the <code>street_addresses</code> array
in the response MISSING[]
- birthdayMonth? int - The month value for the contact's birthday. Valid values are from 1 through 12. The <code>birthday_month</code> property is required if you use <code>birthday_day</code>
- otherStreet? string - Line one of the other street address for the contact
- street2? string - Line two of the primary street address for the contact. This value is automatically appended to the <code>street</code> value. Use this field to add the default kind for line two of the street address to the imported contact's address. The default <code>kind</code> is <code>other</code>
- state? string - The name of the primary state or province for the contact. Use this field to add the default kind of state to the imported contact's home address. The default <code>kind</code> is <code>home</code>
- workCountry? string - The name of the country where the contact works
- homeStreet? string - Line one of the home street address for the contact
- firstName? string - The first name of the contact
- jobTitle? string - The job title of the contact
- email? string - The email address of the contact. This method identifies each unique contact using their email address. Required if
sms_numberis not specified
- zip? string - The zip or postal code associated with the contact's primary address. Use this field to add the default kind of zip to the imported contact's street address. The default <code>kind</code> is <code>home</code>
- otherState? string - The name of another state or province where the contact is located
- homePhone? string - The home phone number for the contact
- workCity? string - The name of the city where the contact works
- otherCity? string - The name of another city where the contact is located
- smsConsentDate? string - Required if the SMS permission is set to
explicit. The date that the contact consented to receiving SMS messages. 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
- lastName? string - The last name of the contact
- workZip? string - The zip or postal code associated with the contact's work address
- otherPhone? string - A phone number for the contact
- otherStreet2? string - Line two of the other street address for the contact. This value is automatically appended to the <code>other_street</code> value
- homeState? string - The name of the home state or province where the contact lives
- homeCity? string - The name of the city where the contact lives
- workStreet? string - Line one of the work street address for the contact
- phone? string - The primary phone number for the contact. Use this field to add the default kind of phone number to the imported contact's phone number. Default <code>kind</code> is <code>other</code>
- otherCountry? string - The name of another country where the contact is located
- companyName? string - The name of the company where the contact works
- otherZip? string - The zip or postal code associated with the contact's other address
- anniversary? string - The anniversary date for the contact. For example, this value could be the date when the contact first became a customer of an organization in Constant 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
- smsNumber? string - The US phone number to associate with the contact's SMS-enabled phone. The country code must be valid. Valid formats are <code>1231231234</code> or <code>123-123-1234</code>. Required if
emailis not specified
constantcontact: LineItemDetailsDto
Fields
- amount? string - The formatted amount of the line item
- name? string - The name of the line item
- amountUnformatted? decimal - The unformatted amount of the line item
- lineItemType? string - Type of line item
constantcontact: Link
Fields
- href? string -
constantcontact: Links
HATEOAS links for navigation. Is null if no additional navigation links are available
Fields
- next? Href -
- prev? Href -
- self? Href -
constantcontact: ListAccountEmailAddressesQueries
Represents the Queries record for the operation: listAccountEmailAddresses
Fields
- emailAddress? string - Use the
email_addressquery parameter to search for a specific account email address
- roleCode? "CONTACT"|"C"|"BILLING"|"B"|"JOURNALING"|"J"|"REPLY_TO"|"R"|"OTHER"|"O" - Use the
role_codequery parameter to search for account emails that have a specific role. Each each email address in an account can have multiple roles or no role. Possible values areCONTACT,BILLING,REPLY_TO,JOURNALING, orOTHER. You can also abbreviate the value of this query parameter and useC,B,R,J, orO
- confirmStatus? "CONFIRMED"|"C"|"UNCONFIRMED"|"U" - Use the
confirm_statusquery parameter to search for account emails using the email status. Possible values areCONFIRMEDorUNCONFIRMED. You can also abbreviate the values of this query parameter and useCorU
constantcontact: ListActivitiesQueries
Represents the Queries record for the operation: listActivities
Fields
- 'limit int(default 50) - Specifies the number of results displayed per page of output, from 1 - 500, default = 50
- state? "processing"|"completed"|"cancelled"|"failed"|"timed_out" - Use this parameter to filter the response to include only activities in one of the following states: cancelled, completed, failed, processing, or timed_out
constantcontact: ListActivityAddContacts
Fields
- exclude? ListActivityAddContactsExclude -
- 'source ListActivityAddContactsSource - The <code>source</code> object specifies which contacts you are adding to your targeted lists using one of four mutually exclusive properties
- listIds string[] - Specifies which lists (up to 50) you are adding your source contacts to
constantcontact: ListActivityAddContactsExclude
Fields
- contactIds? string[] - Excludes specified contacts (<code>contact_id</code>) from being added to the target list. Applicable if using either the <code>all_active_contacts</code> (billable) or <code>list_ids</code> as the source
constantcontact: ListActivityAddContactsSource
The source object specifies which contacts you are adding to your targeted lists using one of four mutually exclusive properties
Fields
- tagIds? string[] - Adds all contacts assigned with the specified <code>tag_id</code>s to your target lists. This property is mutually exclusive with all other <code>source</code> properties
- engagementLevel? string - Adds all contacts that meet the selected <code>engagement_level </code> to your target lists. This property is mutually exclusive with all other <code>source</code> properties
- segmentId? int - Specifies which contacts you are adding to lists as a single <code>segment_id</code> value. This property is mutually exclusive with <code>list_ids</code>, <code>all_active_contacts</code> (billable), and <code>contact_ids</code>
- contactIds? string[] - Specifies which contacts (up to 500) you are adding to lists as an array of <code>contact_id</code> values. This property is mutually exclusive with <code>list_ids</code>, <code>all_active_contacts</code> (billable), and <code>segment_id</code>
- listIds? string[] - Specifies which contacts you are adding to lists as an array of up to 50 contact <code>list_id</code> values. This property is mutually exclusive with <code>contact_ids</code>, <code>all_active_contacts</code> (billable), and <code>segment_id</code>
- allActiveContacts boolean(default false) - Adds all active (billable) contacts to your targeted lists. This property is mutually exclusive with <code>contact_ids</code>, <code>list_ids</code>, and <code>segment_id</code>
constantcontact: ListActivityRemoveContacts
Fields
- exclude? ListActivityRemoveContactsExclude -
- 'source ListActivityRemoveContactsSource - Specifies the contacts to remove from your target list(s) using one of several mutually exclusive properties
- listIds string[] - Specify up to 50 target <code>list_id</code>s from which to remove contacts
constantcontact: ListActivityRemoveContactsExclude
Fields
- contactIds? string[] - Excludes specified contacts (<code>contact_id</code>) from being deleted from the target list and only applicable if using either the <code>all_active_contacts</code> (billable) or <code>list_ids</code> as the source
constantcontact: ListActivityRemoveContactsSource
Specifies the contacts to remove from your target list(s) using one of several mutually exclusive properties
Fields
- tagIds? string[] - Removes all contacts assigned with the specified <code>tag_id</code>s from your target lists. This property is mutually exclusive with all other <code>source</code> properties
- engagementLevel? string - Removes all contacts that meet the selected <code>engagement_level </code> to your target lists. This property is mutually exclusive with all other <code>source</code> properties
- contactIds? string[] - Include up to 500 <code>contact_id</code> values to remove the contacts from your target lists. This property is mutually exclusive with all other <code>source</code> properties
- listIds? string[] - Include up to 50 <code>list_id</code> values to remove all contact list members from your target list(s). This property is mutually exclusive with all other <code>source</code> properties
- allActiveContacts boolean(default false) - Removes all active (billable) contacts from your targeted lists. This property is mutually exclusive with all other <code>source</code> properties
constantcontact: ListAutomationFlowsResponseDto
Paginated list of automation flow summaries
Fields
- flowSummaries? AutomationFlowSummaryDto[] - List of automation flow summaries for the current page
constantcontact: ListAutomationsQueries
Represents the Queries record for the operation: listAutomations
Fields
- sortDirection? "ASC"|"DESC" - Sort direction, ASC or DESC. Defaults to DESC
- channel? string - Filter by channel
- name? string - Find by workflow name (exact match)
- createdFrom? "SCRATCH"|"TEMPLATE" - Filter by how the workflow was created
- goals? string - Filter by goal tags (e.g. post_purchase_followup, up_sell_and_cross_sell)
constantcontact: ListContactIdXrefsQueries
Represents the Queries record for the operation: listContactIdXrefs
Fields
- sequenceIds string - Comma delimited list of V2 API contact
idsto cross-reference with the V3 APIcontact_idvalue. Endpoint accepts a maximum of 500 ids at a time
constantcontact: ListContactsQueries
Represents the Queries record for the operation: listContacts
Fields
- updatedBefore? string - Use
updated_beforeto search for contacts that have been updated before a specified date. To search for updated contacts within a date range, specify bothupdated_afterandupdated_beforedates. Accepts ISO-8601 formatted dates
- include? "custom_fields"|"list_memberships"|"phone_numbers"|"street_addresses"|"taggings"|"notes" - Use
includeto specify which contact sub-resources to include in the response. Use a comma to separate multiple sub-resources. Valid values:custom_fields,list_memberships,taggings,notes,phone_numbers,street_addresses
- createdAfter? string - Use
created_afterto search for contacts created after a specified date. To search for contacts created within a date range, specify bothcreated_afterandcreated_beforedates. Accepts ISO-8601 formatted dates
- includeCount? boolean - Set
include_count=trueto include the total number of contacts (contacts_count) that meet all search criteria in the response body
- tags? string - Use to get contact details for up to 50 specified tags. Use a comma to separate each
tag_id
- optoutAfter? string - Use
optout_afterto search for contacts that unsubscribed after a specified date
- createdBefore? string - Use
created_beforeto search for contacts created before a specified date. To search for contacts created within a date range, specify bothcreated_afterandcreated_beforedates. Accepts ISO-8601 formatted dates
- lists? string - Use the
listsquery parameter to search for contacts that are members of one or more specified lists. Use a comma to separate multiplelist_idvalues, up to a maximum of 25
- updatedAfter? string - Use
updated_afterto search for contacts that have been updated after the date you specify. To search for updated contacts within a date range, specify bothupdated_afterandupdated_beforedates. Accepts ISO-8601 formatted dates
- 'limit int(default 50) - Specifies the number of results displayed per page of output in the response, from 1 - 500, default = 50
- optoutBefore? string - Use
optout_beforeto search for contacts that unsubscribed before a specified date
- segmentId? string - Use to get contacts that meet the segment criteria for a single specified
segment_id. This query parameter can only be combined with the limit query parameter. When using thesegment_idquery parameter, the V3 API may return a 202 response code instead of a 200 response. The 202 response code indicates that your request has been accepted, but not fully completed. Retry sending your API request to return the completed results and a 200 response code
- email? string - Use the
emailquery parameter to search for a contact using a specific email address
- smsStatus? "all"|"explicit"|"unsubscribed"|"pending_confirmation"|"not_set" - Use to get contacts by their SMS status. This parameter accepts one or more comma separated values:
all,explicit,unsubscribed,pending_confirmation,not_set
- status? "all"|"active"|"deleted"|"not_set"|"pending_confirmation"|"temp_hold"|"unsubscribed" - Use the
statusquery parameter to search for contacts by status. This parameter accepts one or more comma separated values:all,active,deleted,not_set,pending_confirmation,temp_hold, andunsubscribed
constantcontact: ListCustomFieldsQueries
Represents the Queries record for the operation: listCustomFields
Fields
- 'limit int(default 50) - Specifies the number of results displayed per page of output, from 1 - 100, default = 50
constantcontact: ListEmailCampaignIdXrefsQueries
Represents the Queries record for the operation: listEmailCampaignIdXrefs
Fields
- v2EmailCampaignIds string - Comma separated list of V2 API
campaignIdvalues. You can enter up to 50 V2campaignIdvalues in each request
constantcontact: ListEmailCampaignsQueries
Represents the Queries record for the operation: listEmailCampaigns
Fields
- afterDate? string - Use to return email campaigns with last
updated_attimestamps that are after a specific date and time (in ISO-8601 format). Use with thebefore_datequery parameter to get email campaigns sent within a specific date range
- 'limit Signed32(default 50) - Specifies the number of campaigns to display on each page of output that is returned (from return 1 - 500). The default returns 50 campaigns per page
- beforeDate? string - Use to return email campaigns with
updated_attimestamps that are before a specific date and time (in ISO-8601 format). Use with theafter_datequery parameter to get email campaigns sent within a specific date range
constantcontact: ListEventRegistrationsQueries
Represents the Queries record for the operation: listEventRegistrations
Fields
- next? string - Cursor for pagination used to get the next page of results (mutually exclusive with <code>prev</code>)
- registrationStatus? "PENDING"|"REGISTERED"|"CANCELED"|"EXPIRED"|"IN_PROGRESS, FAILED" - Filter registration results by status
- paymentStatus? "PENDING"|"PAID"|"REFUNDED"|"CANCELLED"|"FAILED"|"CHARGED_BACK" - Filter registration results by payment status
- prev? string - Cursor for pagination used to get the previous page of results (mutually exclusive with <code>next</code>)
- 'limit? string - Limit the number of results returned per page. If specifying both the <code>limit</code> and <code>page_size</code> query parameters, they must be the same value
- sortBy? "first_name"|"last_name"|"email_address"|"registration_status"|"payment_status"|"tickets"|"total" - Specify the field to use to sort the results
- sortOrder? "ASC"|"DESC" - Use to specify how you want the results sorted
- searchText? string - Filter registration results by first name, last name, or email address
- pageSize? string - Alternative to the <code>limit</code> parameter to limit the number of results returned per page. If specifying both the <code>limit</code> and <code>page_size</code> query parameters, they must be the same value
constantcontact: ListEventsQueries
Represents the Queries record for the operation: listEvents
Fields
- next? string - Cursor for retrieving the next page of results. This value is obtained from the
next_cursorfield in a previous response
- prev? string - Cursor for retrieving the previous page of results. This value is obtained from the
prev_cursorfield in a previous response
- 'limit? string - Limit the number of results to return per page. Default and maximum is
100
- sortBy? string - Use to sort resulting events by one of the following properties:
name,start_time,end_time,created_time, orupdated_time
- sortOrder? string - Sort order for the
sort_by parameter. Accepted values includeASC(ascending) orDESC(descending). Defaults toASCifsort_byis provided
- eventStatus? string - Use to return only events that meet the specified status. Acceptable values include
ACTIVE,DRAFT,COMPLETE,DELETED,CANCELLED, andERROR
- searchText? string - Use to return only events that include the specified text
constantcontact: ListIdList100
Fields
- listIds string[] - The array of contact lists <code>list_id</code> to delete
constantcontact: ListInput
Fields
- name string - The name given to the contact list
- description? string - Text describing the list
- favorite boolean(default false) - Identifies whether or not the account has favorited the contact list
constantcontact: ListListIdXrefsQueries
Represents the Queries record for the operation: listListIdXrefs
Fields
- sequenceIds string - Comma delimited list of V2 API list
idsto cross-reference with the V3 APIlist_idvalue. Endpoint accepts a maximum of 500 ids at a time
constantcontact: ListListsQueries
Represents the Queries record for the operation: listLists
Fields
- 'limit int(default 50) - Use to specify the number of results displayed per page of output, from 1 - 500, default = 50
- name? string - Use to get details for a single list by entering the full name of the list
- includeMembershipCount? "all"|"active" - Use to include the total number of contacts per list. Set to
active, to count only active (mailable) contacts, orallto count all contacts
- includeCount boolean(default false) - Set
include_counttotrueto return the total number of contact lists that meet your selection criteria
- channelType? "email"|"sms" - Use to return lists by channel type. The default value is
email
- includeSmsMembershipCount? boolean - Set to
trueto return the total number of SMS members in each list. Only applicable whenchannel_typeissms. Default isfalse
- status? "all"|"active"|"deleted" - Use to get lists by status. Accepts comma-separated status values
constantcontact: ListPartnerAccountsQueries
Represents the Queries record for the operation: listPartnerAccounts
Fields
- accountType "all"|"managed"|"unmanaged" (default "all") - Filters client account results by account type:
all(default),managed, orunmanaged. Excluding theaccount_typequery parameter returns all client accounts for the partner
- offset? string - Depending on the
limityou specify, the system determines theoffsetparameter to use (number of records to skip) and includes it in the link used to get the next page of results
- 'limit string(default "50") - The number of client accounts to return on each page of results. The default value is
50. Entering alimitvalue less than the minimum (10) or greater than the maximum (50) is ignored and the system uses the default values. Depending on thelimityou specify, the system determines theoffsetparameter to use (number of records to skip) and includes it in the link used to get the next page of results
constantcontact: ListSegmentsQueries
Represents the Queries record for the operation: listSegments
Fields
- 'limit string(default "1000") - The number of segments to return on a page
- sortBy string(default "date") - Specify the segment sort order to use. Sort by name (
sort_by=name) in ascending order, or sort by date (sort_by=date) in descending order with the most recently updated segments listed first
constantcontact: ListSocialHashtagGroupsQueries
Represents the Queries record for the operation: listSocialHashtagGroups
Fields
- 'limit int(default 5) - Maximum number of hashtag groups to retrieve per page. Default and maximum is
5
- page int(default 0) - Page number to retrieve (0-based)
constantcontact: ListSocialProfilesQueries
Represents the Queries record for the operation: listSocialProfiles
Fields
- include? string[] - Optional sub-resources to include. Use
accessibleto check if profiles are accessible on the network
constantcontact: ListTagsQueries
Represents the Queries record for the operation: listTags
Fields
- 'limit int(default 50) - Use to specify the number of tag results (up to
500) to display per page of output. The default is50
- includeCount boolean(default false) - Returns the total number of contacts (
contacts_count) to which a tag applies
constantcontact: ListXref
The cross-referenced pair of V3 API list_id and V2 API sequence_id for a list. Response is sorted ascending by sequence_id
Fields
- listId? string - The V3 API list unique identifier
- sequenceId? string - The V2 API list unique identifier
constantcontact: ListXrefs
Fields
- xrefs? ListXref[] - An array of cross-referenced V3 API <code>list_id</code> and V2 API <code>sequence_id</code> properties. Response is sorted ascending by <code>sequence_id</code>
constantcontact: LpreportingLinks
Fields
- next LpreportingNext -
constantcontact: LpreportingNext
Fields
- href string - The next link in the page or null if there are no additional pages
constantcontact: MapOfstringAndstring
Fields
- string... - Rest field
constantcontact: Next
Fields
- href string - The next link in the page, or null if there are no additional pages
constantcontact: Note
A note about the contact
Fields
- noteId? string - The ID that uniquely identifies the note (UUID format)
- createdAt? string - The date that the note was created
- content? string - The content for the note
constantcontact: OAuth2RefreshTokenGrantConfig
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://authz.constantcontact.com/oauth2/default/v1/token") - Refresh URL
constantcontact: OnlineMeetingDto
Fields
- providerType? string - The type of online meeting provider for the event
- instructions? string -
- lastUpdateTime? string - Last modification time of the event. ISO format
- createTime? string - Create time of the event. ISO format
- label? string -
- url? string - The URL to use for the online meeting
- enabledFlag? boolean -
constantcontact: OpensTrackingActivitiesPage
Fields
- links? ReportingLinks -
- trackingActivities OpensTrackingActivity[] - Lists contacts that opened the specified <code>campaign_activity_id</code>
constantcontact: OpensTrackingActivity
Fields
- trackingActivityType string - The type of tracking activity that is associated with this <code>campaign_activity_id</code> and used for reporting purposes
- createdTime string - The date and time that the contact opened the email campaign activity
- campaignActivityId string - The ID that uniquely identifies an email campaign activity
- emailAddress string - The email address used to send the email campaign activity to a contact
- lastName? string - The last name of the contact
- deviceType? string - The type of device that the contact used to open the email campaign activity
- contactId string - The ID that uniquely identifies a contact
- firstName? string - The first name of the contact
- deletedAt? string - If applicable, displays the date that the contact was deleted
constantcontact: OptoutsTrackingActivitiesPage
Fields
- links ReportingLinks -
- trackingActivities OptoutsTrackingActivity[] - The list of opt-out tracking activities
constantcontact: OptoutsTrackingActivity
Fields
- trackingActivityType string - The type of report tracking activity that is associated with the specified <code>campaign_activity_id</code>
- createdTime string - The time that the contact chose to opt-out from receiving future email campaign activities
- campaignActivityId string - The ID that uniquely identifies the email campaign activity
- emailAddress string - The contact's email address
- optOutReason? string - The opt-out reason, if the contact entered a reason
- lastName? string - The last name of the contact
- contactId string - The ID that uniquely identifies a contact
- firstName? string - The first name of the contact
- deletedAt? string - If applicable, displays the date that the contact was deleted
constantcontact: OrderDetailsDto
Fields
- ticketsText? string - Text that describes the event and ticket information
- number? string - The system assigned string value used to identify the event order
- ticketsLink? string - The URL used to access purchased tickets
- paymentStatus? string - The event registration payment status. Acceptable values include; <code>PENDING</code>, <code>PAID</code>, <code>REFUNDED</code>, <code>CANCELLED</code>, <code>FAILED</code>, <code>CHARGED_BACK</code>, <code>PENDING</code>, <code>UNKNOWN</code
- paymentTime? string - Displays the date and time the payment was made, in ISO format
- paymentTransactionId? string - The unique ID used to identify a payment transaction
- details? LineItemDetailsDto[] -
- title? string - The title for the order
- paymentMethod? string - The payment method used when the order was placed. Acceptable payment methods include;
STRIPEandPAYPAL
constantcontact: OrderTicketKeysRequestDto
Request payload for ticket check-in operations
Fields
- orderTicketKeys string[] - Array of order ticket keys to process
constantcontact: PagedEmailCampaignResponse
Fields
- campaigns? EmailCampaigns[] -
- links? EmailsPagingLinks -
constantcontact: PagedHashtagGroupsDto
A paginated response containing a page of hashtag groups
Fields
- links PagedResponseLinksDto -
- hashtagGroups HashtagGroupDto[] - The current page of hashtag group results
- page PageMetadataDto - Pagination metadata describing the current page of results
constantcontact: PagedResponseLinkRelDto
Represents a link to a page of results
Fields
- href string - The URI of a page of results
constantcontact: PagedResponseLinksDto
Pagination links for navigating through pages of results
Fields
- next? PagedResponseLinkRelDto - Represents a link to a page of results
constantcontact: PageMetadataDto
Pagination metadata describing the current page of results
Fields
- size int - The page size (the number of results returned in this response)
- totalElements int - The total number of results available across all pages
- page int - The current 0-based page number
- totalPages int - The total number of pages available based on the current page size
constantcontact: PaginatedRegistrations
Fields
- prevCursor? string - Use to get the previous page of results
- nextCursor? string - Use to get the next page of results
- links? RegistrationsLinks -
- records? RegistrantInformationLiteDto[] -
- totalRecords? Signed32 - The total number of resulting records
constantcontact: PaginationDtoEventListingDto
Fields
- prevCursor? string - Use to get the previous page of results
- nextCursor? string - Use to get the next page of results
- records? EventListingDto[] - List of events for the current page
- links? Links -
- totalRecords? Signed32 - The total number of events across all pages
constantcontact: PaginationLinks
Fields
- next? PartnersLink -
constantcontact: PagingLinks
Fields
- next? Link -
constantcontact: ParameterDto
A single trigger parameter used to filter or configure the trigger (e.g., list IDs). Use parameter_value (preferred); parameter_string_value and parameter_list_value are supported for backwards compatibility
Fields
- parameterValue? record {} - The parameter value: a string or array of strings depending on type (e.g., STRING → single value, LIST → array of list IDs). Use this instead of parameter_string_value / parameter_list_value moving forward
- rule? record {} - Rule structure for RULE-type parameters (e.g., engagement level triggers)
- parameterName? string - Name of the parameter (e.g., list_ids, create_source, url)
- parameterStringValue? string - [DEPRECATED] String value for the parameter when type is STRING. Supported for backwards compatibility; prefer parameter_value
- 'type? string - Parameter type. Common trigger types: STRING (single value), LIST (array), WEB_TRACKING (page visit)
- operator? string - Comparison operator for the parameter (e.g. EQUALS, CONTAINS, NOT_EQUALS)
- parameterListValue? string[] - [DEPRECATED] List of string values for the parameter when type is LIST. Supported for backwards compatibility; prefer parameter_value
constantcontact: PartnerAccount
Fields
- siteOwnerList PartnerAccountSiteOwnerList[] - Lists all Constant Contact client accounts that are managed under a partner account
- links? PaginationLinks -
constantcontact: PartnerAccountOperationsRequest
JSON object that contains the fields Constant Contact uses to construct the HTTP request you are sending on behalf of a managed account
Fields
- accountOperationMethod string - The http method for the request you are sending on behalf of a managed child account
- accountOperationPayload? string - The request payload for the request you are sending on behalf of a managed child account. If you provide a JSON payload using this parameter, make sure that the JSON is string escaped
- accountOperationPathParameters? PathParamObject[] - An array containing the path parameters for the request you are sending on behalf of a managed child account
- accountOperationQueryParameters? QueryParamObject[] - An array containing the query parameters for the request you are sending on behalf of a managed child account
- accountOperationHeaders? HeadersObject[] - An array containing the headers for the request you are sending on behalf of a managed child account
- accountOperationUrl string - The API method path for the request you are sending on behalf of a managed child account. This value should be a V3 API URL without the https://api.cc.email/v3 base url and with any path parameter names included. For example: <code>/emails/activities/{campaign_activity_id}</code>
constantcontact: PartnerAccountSiteOwnerList
Fields
- encodedAccountId? string - The obfuscated ID used to uniquely identify a client account
- subscriberCount? int - The total number of subscriber contacts that are associated with a client account
- billingStatus? string - The client's account billing status. When you first create a client account the
billing statusdefaults toTrial. Billing status values include: <ul> <li><code>Trial</code> - A non-paying trial client account (default value).</li> <li><code>Open</code> - An active and paying client account.</li> <li><code>Canceled</code> - A canceled client account.</li> <li><code>Trial End</code> - The trial period has ended for this client account.</li> </ul>
- organizationName? string - The name of the organization associated with this client account
- lastLoginDate? string - The system generated date and time (ISO-8601) showing when the client last logged into their Constant Contact account. If a client has not logged into their account, the value is
null. This property does not display in the results
- siteOwnerName? string - The user name that identifies a client account
constantcontact: PartnersLink
Fields
- href? string -
constantcontact: PartnerUnsubscribeResponse
Response indicating the number of contacts that were successfully unsubscribed
Fields
- unsubscribedCount? int - The number of contacts that were successfully unsubscribed
constantcontact: PathParamObject
Fields
- pathParamKey? string - The name of the path parameter
- pathParamValue? string - The value of the path parameter
constantcontact: PaymentStatusUpdateRequestDto
Request payload to update payment status
Fields
- paymentStatus string - New payment status to set
- registrationIds string[] - List of registration IDs to update
constantcontact: PContactAddTrackingActivitiesPage
Fields
- links LpreportingLinks -
- trackingActivities PContactAddTrackingActivity[] - The list of landing page contact adds tracking activities
constantcontact: PContactAddTrackingActivity
Fields
- trackingActivityType string - The tracked activity event type
- createdTime string - The time the tracking activity occurred
- campaignActivityId string - The unique ID that identifies of the campaign activity to use
- emailAddress string - The email address for the contact and tracking activity
- smsChannel? TrackingActivitySmsChannelDTO -
- lastName? string - The last name of the contact
- contactId string - The unique ID that identifies the contact
- firstName? string - The first name of the contact
- deletedAt? string - The time the Contact was deleted
constantcontact: PContactClickTrackingActivitiesPage
Fields
- links LpreportingLinks -
- trackingActivities PContactClickTrackingActivity[] - The list of landing page contact click tracking activities
constantcontact: PContactClickTrackingActivity
Fields
- trackingActivityType string - The tracked activity event type
- createdTime string - The time the tracking activity occurred
- campaignActivityId string - The unique ID that identifies of the campaign activity to use
- emailAddress string - The email address for the contact and tracking activity
- smsChannel? TrackingActivitySmsChannelDTO -
- lastName? string - The last name of the contact
- linkUrl string - The URL link text
- deviceType? string - The type of device that was used to click the link
- urlId? string - The ID used to uniquely identify the link
- contactId string - The unique ID that identifies the contact
- firstName? string - The first name of the contact
- deletedAt? string - The time the Contact was deleted
constantcontact: PContactOpensTrackingActivitiesPage
Fields
- links LpreportingLinks -
- trackingActivities PContactOpenTrackingActivity[] - The list of landing page contact opens tracking activities
constantcontact: PContactOpenTrackingActivity
Fields
- trackingActivityType string - The tracked activity event type
- createdTime string - The time the tracking activity occurred
- campaignActivityId string - The unique ID that identifies of the campaign activity to use
- emailAddress string - The email address for the contact and tracking activity
- smsChannel? TrackingActivitySmsChannelDTO -
- lastName? string - The last name of the contact
- deviceType? string - The type of device that was used to open the link
- contactId string - The unique ID that identifies the contact
- firstName? string - The first name of the contact
- deletedAt? string - The time the Contact was deleted
constantcontact: PContactSMSOptInTrackingActivitiesPage
Fields
- links LpreportingLinks -
- trackingActivities PContactSMSOptInTrackingActivity[] - The list of landing page contact opt in tracking activities
constantcontact: PContactSMSOptInTrackingActivity
Fields
- trackingActivityType string - The tracked activity event type
- createdTime string - The time the tracking activity occurred
- campaignActivityId string - The unique ID that identifies of the campaign activity to use
- emailAddress string - The email address for the contact and tracking activity
- smsChannel? TrackingActivitySmsChannelDTO -
- lastName? string - The last name of the contact
- contactId string - The unique ID that identifies the contact
- firstName? string - The first name of the contact
- deletedAt? string - The time the Contact was deleted
constantcontact: PContactUpdateTrackingActivitiesPage
Fields
- links LpreportingLinks -
- trackingActivities PContactUpdateTrackingActivity[] - The list of landing page contact update tracking activities
constantcontact: PContactUpdateTrackingActivity
Fields
- trackingActivityType string - The tracked activity event type
- createdTime string - The time the tracking activity occurred
- campaignActivityId string - The unique ID that identifies of the campaign activity to use
- emailAddress string - The email address for the contact and tracking activity
- smsChannel? TrackingActivitySmsChannelDTO -
- lastName? string - The last name of the contact
- contactId string - The unique ID that identifies the contact
- firstName? string - The first name of the contact
- deletedAt? string - The time the Contact was deleted
constantcontact: PercentsEmail
Fields
- desktopClick? decimal - Percentage of clicks that came from a standard desktop or laptop computer
- bounce? decimal - Percentage of emails sent to unique recipients that bounced
- unsubscribe? decimal - Percentage of recipients that received the email (did not bounce) and chose to unsubscribe
- mobileOpen? decimal - Percentage of opens that came from a mobile phone, tablet computer, or similar small mobile device (e.g. iPhone or iPad)
- mobileClick? decimal - Percentage of clicks that came from a mobile phone, tablet computer, or similar small mobile device (e.g. iPhone or iPad)
- didNotOpen? decimal - Percentage of recipients that received the email (did not bounce) but did not open it
- desktopOpen? decimal - Percentage of opens that came from a standard desktop or laptop computer
- click? decimal - Percentage of recipients who opened the email who also clicked one or more links in it
- open? decimal - Percentage of recipients that received the email (did not bounce) and opened it
constantcontact: PhoneNumber
Fields
- phoneNumberId? string - Unique ID for the phone number
- createSource? string - Identifies who added the phone number; valid values are Contact or Account
- updatedAt? string - Date and time that the phone number was last updated, in ISO-8601 format. System generated
- kind? string - Identifies the type of phone number; valid values are home, work, mobile, or other
- createdAt? string - Date and time that the street address was created, in ISO-8601 format. System generated
- phoneNumber? string - The contact's phone number
- updateSource? string - Identifies who last updated the phone number; valid values are Contact or Account
constantcontact: PhoneNumberPut
Fields
- kind? string - Identifies the type of phone number; valid values are home, work, mobile, or other
- phoneNumber? string - The contact's phone number
constantcontact: PlanInfo
Specifies the type of billing plan and the billing date to use for a client account
Fields
- planType? string - Use this property to update the client account billing plan to a different billing plan. After changing the <code>plan_type</code> from <code>TRIAL</code> to any other billing plan type, you cannot change it back to <code>TRIAL</code>. <ul> <li><code>TRIAL</code>: A non-billable account with an expiration date that allows clients to try Constant Contact product features.</li> <li><code>GOLD</code>: A billable client account plan.</li> <li><code>SILVER</code>: A billable client account plan.</li> <li><code>BRONZE</code>: A billable client account plan.</li> </ul>
- billingDayOfMonth? Signed32 - This property is required if a client account is not set up to use single billing. You can choose to enter a specific day of the month or accept the default value, which is the day on which the <code>plan_type</code> value changes from a <code>TRIAL</code> plan to a different <code>plan_type</code>. For trial accounts, the value defaults to null. You can only change the <code>billing_day_of_month</code> when changing the <code>plan_type</code> value from <code>TRIAL</code> to a different <code>plan_type</code>, otherwise the value you enter is ignored
- planGroupId? Signed32 - Updates an existing client account billing plan group to a new billing plan group. If you don't know the
plan_group_idto use, contact our API support team
constantcontact: PlanTiersObject
Specifies client billing plan details including the type of plan, the plan tiers used, the current billing status, and the day of the month that the client is billed. When a client account is first provisioned, the plan_type defaults to a Trial account. After you change an account billing_status from Trial to any other billing_status, you cannot change it back to a Trial account
Fields
- planType? string - The billing plan that is associated with a client's Constant Contact account. The billing plan determines which Constant Contact product features that the client account can access. If you are not on the latest billing plan, contact the Constant Contact Partner Team. However, older billing plans and <code>plan_type</code> enum values will continue to be supported. <ul> <li><code>TRIAL</code>: Provides limited product features for a non-billed account and the account has an expiration date.</li> <li><code>BRONZE</code>: Billable plan that provides basic email and marketing tools.</li> <li><code>SILVER</code>: Billable plan that provides all features available in the <code>BRONZE</code> plan, and adds some additional email campaign to features, such as contact segmentation and social media ads integration.</li> <li><code>GOLD</code>: Billable plan that provides all available product features.</li> </ul>
- currentTiers? TierObject[] - Lists the billing plan tiers that are currently associated with a client account
- billingDayOfMonth? Signed32 - This property is required when an account is not set up to use single billing. For trial accounts, the value is initially set to <code>null</code>. The value can only be changed when changing the <code>plan_type</code> from a trial account to a different type of plan, otherwise the value you enter is ignored. You can choose to enter a specific day of month or except the default value, which is the day that the <code>plan_type</code> value changes from a trial account plan to a different plan. Valid <code>billing_day_of_month</code> values include <code>1</code> through and including <code>31</code>
- billingStatus? string - The client's account billing status. When you first create a client account the <code>billing_status</code> defaults to <code>Trial</code>. Billing status values include: <ul> <li><code>Trial</code> - A non-paying trial client account (default value).</li> <li><code>Open</code> - An active and paying client account.</li> <li><code>Canceled</code> - A canceled client account.</li> <li><code>Trial End</code> - The trial period has ended for this client account.</li> </ul>
constantcontact: PostCreateDto
Request body for creating a social media post campaign that can include multiple posts to multiple social profiles
Fields
- profilePosts ProfilePostDto[] - 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
- name? string - 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, so the value returned may not exactly match what was sent
- scheduledTime? string - The date and time to publish the post, in ISO-8601 format. Only applies when <code>status</code> is <code>SCHEDULED</code>. If not specified for a scheduled post, the publish job is scheduled to execute immediately
- status string - The status of the post on creation. Valid values are <code>DRAFT</code> (save without publishing) or <code>SCHEDULED</code> (schedule for publication)
constantcontact: PostDto
Represents a social media post campaign that can include multiple posts to multiple social profiles, with either identical or network-specific content
Fields
- profilePosts ProfilePostDto[] - The list of per-profile posts that make up this campaign
- name? string - Campaign name for this post. The value provided on creation is sanitized before saving, so the returned value may not exactly match what was sent
- scheduledTime? string - The date and time to publish the post, in ISO-8601 format. Only set when <code>status</code> is <code>SCHEDULED</code>
- campaignId? string - Unique identifier for the post campaign. Generated by the server on creation. Use this value to reference the post in subsequent requests
- status string - The current status of the post. Possible values include: <ul> <li><code>DRAFT</code> — saved without being scheduled for publication</li> <li><code>SCHEDULED</code> — scheduled for future publication at <code>scheduled_time</code></li> <li><code>EXECUTING</code> — currently being published</li> <li><code>ACTIVE</code> — the post has been published and is active on the social network</li> <li><code>PAUSED</code> — publication has been paused</li> <li><code>SUSPENDED</code> — publication has been suspended</li> <li><code>REMOVED</code> — the post has been removed</li> <li><code>DONE</code> — publication has completed</li> <li><code>ERROR</code> — publication encountered an error</li> </ul>
constantcontact: ProfileDto
Describes a social network profile (Business Page, Company Page/Organization, etc.).
Note: Due to performance and/or rate-limit issues, some properties may be cached. Where possible, caching will be limited to 15 minutes
Fields
- connected boolean - Whether this profile is currently connected. You can only create and publish posts with connected profiles
- accessible? boolean - Whether the profile is currently accessible for posting. Publishing a post will fail if its profile is not currently accessible. Only populated when the GET request includes the query parameter <code>include=accessible</code>
- networkProfileId? string - The social network-specific identifier for this profile
- settings? record { record {}... } - Network-specific settings for the profile. Only populated when the request includes <code>include=accessible</code> and settings are available for the network. Currently, only TikTok provides settings: <pre>"content": { "comment_disabled": Boolean, "duet_disabled": Boolean, "stitch_disabled": Boolean, "max_video_post_duration_sec": Integer }</pre>
- networkUserId? string - The social network-specific identifier for the user who owns this profile
- imageUrl? string - URL of the profile's image or avatar
- profileId string - Unique identifier for this profile. Use this value in the <code>profile_id</code> field of a <code>ProfilePost</code> when creating a post
- accountInfo? AccountInfoDto -
- name? string - Display name of the profile
- 'handle? string - The profile's handle on the social network (for example, an Instagram or TikTok username). May be <code>null</code> if the network does not expose a separate handle (for example, Facebook)
- url? string - URL to the profile on the social network
- network string - The social network this profile belongs to
constantcontact: ProfilePostDto
The content to post to one or more social profiles as part of a social post campaign
Fields
- settings? record { MapOfstringAndstring... } - Network-specific post settings. If no settings are provided, this field will be omitted in the JSON response. All values are persisted as strings. Currently, only TikTok has available settings: <pre>{ "settings": { "tiktok": { "disable_comment": "true", "disable_duet": "false", "disable_stitch": "true", "auto_add_music": "false" } } }</pre>
- images? ImageDto[] - Images to include in the post. Each image must be accessible via a public URL
- postContentId? string - Identifier for this post content. Generated by the server on creation. When updating a post, existing profile posts must include their original <code>post_content_id</code> unchanged
- profiles ProfilePostProfileDto[] - The list of profiles to post to. Can be an empty list only when the post is in <code>DRAFT</code> status
- text? string - The text/caption content for the post. Whether text is required depends on the target social network. In <code>DRAFT</code> status, this is always optional
constantcontact: ProfilePostProfileDto
Describes a post to a single social profile, including the target profile and its current status on that network
Fields
- campaignActivityStatus? string - The status of the post activity for this profile
- campaignActivityStatusDate? string - The activity's timestamp. For <code>SCHEDULED</code> activities, this is typically the same as the scheduled publish time; otherwise, it is the last-modified timestamp
- profileName? string - The display name of the profile
- campaignActivityId? string - The campaign activity ID for this post on the specified profile. Generated by the server on creation. When updating a post, existing profile entries should include their original <code>campaign_activity_id</code>
- postUrl? string - The permalink URL to the published post on the social network. Only set when the status is <code>DONE</code>
- imageUrl? string - The URL of the profile's image. This image may become stale and is only refreshed when retrieving profiles with <code>include=accessible</code>
- profileId string - The unique identifier for the profile to post to. Use the <code>profile_id</code> from <code>GET /social/profiles</code>
- accountUsername? string - The human-readable username of the account that owns this profile
- networkPostId? string - The social network's reference for this post. Only set when the status is <code>DONE</code>
- campaignActivityStatusMessage? string - A human-readable message describing the current status of the post activity. Can be a generic Constant Contact message or a specific message reported by the social network
- network? string - The social network this profile belongs to
constantcontact: PromoCodeDto
Specifies promotion code details
Fields
- discountCodeScope? string - The scope that applies to the discount code
- tickets? TicketSummaryDto[] -
- discountAmount? decimal - The discount dollar amount date to apply to the promotional code
- endTime? string - The date to end the promotional code. ISO format
- quantityUsed? Signed32 - Total number of promotional codes used
- description? string - Promotional code description
- pausedFlag? boolean - Pauses the promotional code
- discountCodeType? string - The type of discount code to use for the event
- startTime? string - The date the promotional code starts. ISO format
- quantityTotal? Signed32 - Total number of promotional codes to accept
- statusLabels? StatusDisplayLabelDto[] - Status display labels with display text and translation key
- name string - The name of the promotional code
- timeLimitFlag? boolean - Indicates a time limit applies to the promotional code
- id? string - The ID to use for the promotion code
- discountPercent? Signed32 - The promotional discount percentage to apply for the promotional code
- deletedTime? string - Delete time of the promo code. ISO format
- items? ItemSummaryDto[] - List of items associated with this promo code
- quantityAvailable? Signed32 - Total number of promotional codes available for use
- status? string - The status of the promo code
constantcontact: PropertyComparisonDto
Fields
- argument? string -
- arrayArgument? string[] -
- 'type? string -
- operator? string -
- propertyName? string -
- stringMapArgument? PropertyComparisonDtoStringMapArgument -
constantcontact: PropertyComparisonDtoStringMapArgument
Fields
- customFieldId? string -
- value? string -
constantcontact: Provision
Fields
- website? string - The client's website URL. Specifying the website URL eliminates the need for clients to provide that information. Requires a valid URL starting with http:// or https://
- managedSiteOwner? boolean - By default, if the client account is setup as a managed account <code>managed_site_owner</code> is automatically set to <code>true</code> and attempting to override the setting with <code>false</code> is ignored. This helps to avoid getting an account into an unknown state
- partnerAccountId? string - The unique client account identifier that partners define and use for billing and reporting purposes
- contactPhone? string - The contact phone number to associate with the client account
- enableSingleBilling? boolean - If a partner account is setup to allow for single billing and the <code>managed_site_owner</code> property is set to <code>true</code>, use this property to enable the single billing feature for the client account. See your account manager for more information
- billingLocale? string - The currency to use when billing the client account. Valid values are: <code>en_US</code> (default, US Dollars) or <code>en_GB</code> (British Pounds)
- lastName? string - The client account owner's last name
- externalId? string - The ID used to uniquely identify the client account for the external authenticator. Do not use the <code>password</code> property when using an external authenticator
- organizationName? string - The name of organization that identifies the client account
- externalProvider? string - The name of the provider who externally authenticates this customer. For example, PayPal or Yahoo. Do not use the <code>password</code> property when using an external authenticator
- contactEmail string - A valid email address to associate with the client account
- countryCode string - The two-letter country code (ISO 3166-1 code) that specifies the country in which the client resides
- password? string - Required if not using Single Sign On (SSO) or external authenticator. The password to associate with the client account. Passwords must be at least 8 characters and no more than 80 characters in length. Passwords can contain alphabetical letters (A-Z) and (a-z), numbers (0-9), special characters (! @ # $ etc.) and spaces. Passwords should not contain any part of your username and cannot be the same as your last password, or be listed on an industry database; we check for easily guessed or compromised passwords. Your new password is not returned in the response payload for security reasons. If using SSO authentication, use <code>idp_provider</code> and <code>idp_provider_id</code> instead of <code>password</code>
- loginName string - A unique login name to associate with the client account. The name must only contain alphanumeric characters and '-', '_', '@','.','+'.
- organizationPhone? string - The organization phone number. To set the organization phone number using the user interface, select <b>My Settings</b> and in the <b>Organization Information</b> section, select <b>Edit Organization Information</b>
- gdprOptOut? boolean - When creating accounts for users who have opted-out of any marketing communications, set the <code> gdpr_opt_out</code> to <code>true</code> so that Constant Contact does not send any marketing communications to the account
- stateCode string - The two-letter state code that represents the US state (<code>country_code</code> is <code>US</code> ) or Canadian province (<code>country_code</code> is <code>CA</code>) where the client's organization is physically located. Leave the <code>state_code</code> blank for non-US states and Canadian provinces
- timeZoneId? string - The offical time zone to use to represent the physical location associated with the client account
- firstName? string - The client account owner's first name
constantcontact: ProvisionResponse
Fields
- provisionUuid? string - The system generated ID used to uniquely identify the provisioning of a client account
- encodedAccountId? string - The system generated ID used to uniquely identify a client account
constantcontact: QueryParamObject
Fields
- queryParamValue? string - The value of the query parameter
- queryParamKey? string - The name of the query parameter
constantcontact: RegistrantInformationLiteDto
Fields
- tickets? Signed32 - Total number of tickets associated with a registration
- registrationStatus? string - The status of a registration. Acceptable values include: <code>PENDING</code>, <code>REGISTERED</code>, <code>CANCELED</code>, <code>EXPIRED</code>, <code>IN_PROGRESS</code>, <code>FAILED</code>
- paymentStatus? string - The current payment status for a registration
- eligibleCheckinTickets? Signed32 - The current checkin status
- lastName? string - The last name of the person that registered for the event
- registrationId? string - The ID that uniquely identifies a registration
- checkinStatus? string - The status of the check-in
- trackKey? string - System generated string used to track a registration
- checkedInTickets? Signed32 - The total number of tickets processed to check in for the event
- total? decimal - The total amount paid for a registration
- emailAddress? string - The email address associated with the registered event user
- newContact? boolean - Set to <code>true</code> to indicate that the contact is new, otherwise set to <code>false</code>
- firstName? string - The first name of the person that registered for the event
- registrationTime? string - The time of event registration, in ISO format
constantcontact: RegistrationsLinks
Fields
- next? Href -
- prev? Href -
- self? Href -
constantcontact: RegistrationStatusUpdateRequestDto
Request payload to update registration status
Fields
- registrationStatus string - New registration status to set
- registrationIds string[] - List of registration IDs to update
constantcontact: RegistrationTicketDto
Fields
- ticketName? string - The name used to identify the ticket
- editable? boolean - Set to <code>true</code> to allow or <code>false</code> to not allow registrations to be modified
- price? decimal - The price for a ticket
- checkedInTime? string - The event check in time date, in ISO format
- fields? SimpleFieldDto[] -
- orderTicketKey? string - The system generated number used to identify a ticket order
constantcontact: ReportingLinks
Fields
- next? ReportingNext -
constantcontact: ReportingNext
Fields
- href? string - The next link in the page or null if there are no additional pages
constantcontact: ReportingsmsLinks
Fields
- next? ReportingsmsNext -
constantcontact: ReportingsmsNext
Fields
- href string - The next link in the page or null if there are no additional pages
constantcontact: ResendToNonOpenersInner
Fields
- resendDate? string - The system generated date and time (in ISO-8601 format) that the email campaign activity was resent to non-openers (only included in the response results for sent resend activities)
- delayMinutes? Signed32 - The number of minutes to wait before Constant Contact resends the email. There are 1,440 minutes in a day. Valid values includes a minimum of <code>720</code> (12 hours) and a maximum of <code>14,400</code> minutes (10 days). This property is mutually exclusive with <code>delay_days</code>
- resendStatus? string - The status of the resend to non-openers campaign activity. The <code>resend_status</code> is only returned in the response results if the campaign activity is either scheduled to be sent or was already sent
- resendRequestId? string - For scheduled or sent resend to non-opener emails, the system generates an ID that identifies the resend to non-openers activity. For draft email campaign resend activities, the system returns <code>DRAFT</code>
- resendSubject? string - The subject line used when resending the email campaign activity
- delayDays? Signed32 - The number of days to wait before Constant Contact resends the email. Valid values include <code>1</code> to <code>10</code> days. This value is only returned in the response results if the resend activity was created with <code>delay_days</code> or the <code>delay_minutes</code> equal to an exact day value.
constantcontact: ResendToNonOpenersInput
Fields
- delayMinutes? Signed32 - The number of minutes to wait before Constant Contact resends the email campaign activity. There are 1,440 minutes in a day. Valid values includes a minimum of <code>720</code> (12 hours) and a maximum of <code>14,400</code> minutes (10 days). This property is mutually exclusive with <code>delay_days</code>
- resendSubject string - The subject line used when resending the email campaign activity
- delayDays? Signed32 - The number of days to wait before Constant Contact resends the email. Valid values include <code>1</code> to <code>10</code> days. This property is mutually exclusive with <code>delay_minutes</code>. This value is only returned in the response results if the resend activity was created with <code>delay_days</code> or the <code>delay_minutes</code> equal to an exact day value
constantcontact: ResendToNonOpenersObject
Fields
- resendDate? string - The system generated ISO-8601 format date and time that Constant Contact resent the email to non-openers
- delayMinutes? Signed32 - The number of minutes to wait before Constant Contact resends the email. There are 1,440 minutes in a day. Valid values includes a minimum of <code>720</code> (12 hours) and a maximum of <code>14,400</code> minutes (10 days). This property is mutually exclusive with <code>delay_days</code>
- resendRequestId? string - For scheduled or sent resend to non-opener emails, this property is a unique identifier for the resend. For draft email campaign resend activities, the value of this property is <code>DRAFT</code>
- resendSubject? string - The subject line for the resend email
- delayDays? Signed32 - The number of days to wait before Constant Contact resends the email. Valid values include <code>1</code> to <code>10</code> days. This property is mutually exclusive with <code>delay_minutes</code>. This value is only returned in the response results if the resend activity was created with <code>delay_days</code> or the <code>delay_minutes</code> equal to an exact day value
constantcontact: SegmentData
Fields
- segmentCriteria string - The <code>segment_criteria</code> specifies the contact data that Constant Contact uses to evaluate and identify contacts that meet your criteria. The <code>segment_criteria</code> must be formatted as single-string escaped JSON. The top-level <code>group</code> <code>type</code> must be <code>add</code>
- name string - The segment's unique descriptive name
constantcontact: SegmentDetail
Fields
- segmentCriteria? string - The segment's contact selection criteria formatted as single-string escaped JSON
- name? string - The segment's unique descriptive name
- createdAt? string - The system generated date and time (ISO-8601) that the segment was created
- editedAt? string - The system generated date and time (ISO-8601) that the segment's <code>name</code> or <code> segment_criteria</code> was last updated
- segmentId? Signed32 - The system generated number that uniquely identifies the segment
constantcontact: SegmentMaster
Fields
- name? string - The segment's unique descriptive name
- createdAt? string - The system generated date and time that the segment was created (ISO-8601 format)
- editedAt? string - The system generated date and time that the segment's <code>name</code> or <code>segment_criteria</code> was last updated (ISO-8601 format)
- segmentId? Signed32 - The system generated number that uniquely identifies the segment
constantcontact: SegmentName
Fields
- name string - The segment's unique descriptive name
constantcontact: SegmentsDTO
Fields
- links? SegmentsLinks -
- segments SegmentMaster[] - Lists all segments for the account
constantcontact: SegmentsLinks
Fields
- next Next -
constantcontact: SendsTrackingActivitiesPage
Fields
- links? ReportingLinks -
- trackingActivities SendsTrackingActivity[] - Lists the contacts to which the email campaign activity (<code>campaign_activity_id</code>) was sent
constantcontact: SendsTrackingActivity
Fields
- trackingActivityType string - The type of tracking activity that is associated with this <code>campaign_activity_id</code> and used for reporting purposes
- createdTime string - The date and time that you sent the email campaign to the contact
- campaignActivityId string - The ID that uniquely identifies an email campaign activity
- emailAddress string - The email address used to send the email campaign activity to a contact
- lastName? string - The last name of the contact
- contactId string - The ID that uniquely identifies a contact
- firstName? string - The first name of the contact
- deletedAt? string - If applicable, displays the date that the contact was deleted
constantcontact: SimpleFieldDto
An array of contact details
Fields
- fieldLabel? string - The label used to identify a field within each contact details section
- displayOrder? Signed32 - If specified, determines the order in which to return a subset of contact's details. For example, if you want a contact's email address to display first, set the <code>display_order</code> to <code>1</code> within the <code>field_label</code>: <code>CONTACT_EMAIL_ADDRESS</code> details section
- fieldValue? string - The value of the field for this contact. For example, if the field is an email address, the field_value would contain the actual email address
- choices? string[] - For SINGLE_SELECT and MULTI_SELECT field types, this array contains the available options the registrant can choose from
- fieldType? string - Identifies the type of field. Acceptable values include; TEXT_AREA, DATE, SINGLE_SELECT,MULTI_SELECT, INFORMATIONAL, TERMS_CONDITIONS, ADDRESS, HEADER, DIVIDER, STATIC_TEXT
- fieldName? string - The formatted name used to identify a field within each contact details section
- labelKey? string - The label used to identify a contact's registration details
constantcontact: SmsCampaignSummariesPage
Fields
- links? ReportingsmsLinks -
- bulkSmsCampaignSummaries? BulkCampaignSummary[] - Provides details about each SMS campaign, including the total unique counts for each tracked campaign activity
- aggregatePercents? BulkSmsCampaignSummariesPercents -
constantcontact: SmsChannelConsentDetails
Provides SMS consent details
Fields
- advertisedFrequency? string - The numeric used to set how often to send SMS advertisements during a specified time interval (<code>advertised_interval</code>). For example, if the <code>advertised_frequency</code> is set to <code>2</code> and the <code>advertised_interval</code> is set to <code>monthly</code>, the contact can receive up to two advertisements per month
- optOutDate? string - Date and time, in ISO-8601 format, that the contact unsubscribed/opted-out of receiving SMS from the account. Displays only if the contact unsubscribed/opted-out. System generated
- advertisedInterval? string - Identifies the unit of time used by Constant Contact to send SMS advertisements as a string enum. For example, if the <code>advertised_frequency</code> is set to <code>2</code> and the <code>advertised_interval</code> is set to <code>monthly</code>, the contact can receive up to two advertisements per month
- updatedAt? string - Date and time that the SMS stats were updated, in ISO-8601 format. System generated
- optInDate? string - Date and time, in ISO-8601 format, that the contact subscribed/opted-in to receiving SMS from the account. Displays only if the contact subscribes/opts-in. System generated
- createdAt? string - Date and time that the SMS stats were created, in ISO-8601 format. System generated
- smsConsentPermission? string - Identifies the current permission status for the SMS channel
- consentType? string - Identifies the type of consent provided. Currently, only <code>promotional_sms</code> is supported
constantcontact: SmsEngagementHistoryInner
Provides a contact's SMS engagement history details. The properties returned depend on the type of SMS consent granted by the contact
Fields
- historyDetails? HistoryDetails -
- insertTime? string - The date and time that the history record was created, in ISO-8601 format. System generated
- smsChannelHistoryId? string - The unique SMS channel history UUID
- contactId? string - The unique contact UUID
- smsChannelId? string - The unique SMS channel UUID
constantcontact: SSOUser
Specify client account user's details. All fields are required
Fields
- roleName string - The role (<code>account_manager</code> or <code>campaign_creator</code>) to assign the client account user
- loginName string - The login name to associate with the new client account user
- lastName string - The client account user's last name
- externalId string - The unique ID used to identify the client account user to the external authenticator
- firstName string - The client account user's first name
- externalProvider string - The unique name used to identify the external provider used to authenticate the client account user. For a list of external providers, contact the Constant Contact Partner Team
- contactEmail string - The unique email address to associate with the new client account user
constantcontact: StatsEmail
Fields
- emClicks? Signed32 - Number of unique recipients who clicked any link in the email
- emClicksAllOther? Signed32 - Number of non-unique email clicks on an unknown device (e.g. Game Console or Wearable)
- emNotOpened? Signed32 - Number of unique recipients who did not open the email. This is calculated as follows: <code>em_not_opened</code> is equal to <code>em_sends - em_opens - em_bounces</code>. This value is reported as zero if the calculation results in a negative value
- emOpensAll? Signed32 - Total number of non-unique email opens
- emBounces? Signed32 - Number of unique email bounces
- emOpensAllOther? Signed32 - Number of non-unique email opens on an unknown device (e.g. Game Console or Wearable)
- emSends? Signed32 - Number of unique email sends
- emClicksAllTablet? Signed32 - Number of non-unique email clicks on a small tablet type computer (e.g. iPad)
- emOpensAllMobile? Signed32 - Number of non-unique email opens on a mobile phone or similar small mobile device (e.g. iPhone)
- emClicksAll? Signed32 - Total number of non-unique email clicks
- emOptouts? Signed32 - Number of unique recipients who unsubscribed due to this email
- emClicksAllNone? Signed32 - Number of non-unique email clicks for which the device type was not captured. This will account for any clicks prior to when device type was collected and stored
- emForwards? Signed32 - Number of unique recipients who forwarded the email using the forward to a friend feature (not available for all types of emails)
- emClicksAllComputer? Signed32 - Number of non-unique email clicks on a standard desktop or laptop computer
- emOpensAllNone? Signed32 - Number of non-unique email opens for which the device type was not captured. This will account for any opens prior to when device type was collected and stored
- emOpens? Signed32 - Number of unique recipients who opened the email
- emClicksAllMobile? Signed32 - Number of non-unique email clicks on a mobile phone or similar small mobile device (e.g. iPhone)
- emOpensAllComputer? Signed32 - Number of non-unique email opens on a standard desktop or laptop computer
- emOpensAllTablet? Signed32 - Number of non-unique email opens on a small tablet type computer (e.g. iPad)
constantcontact: StatsEmailActivity
Fields
- emClicks? Signed32 - Number of unique recipients who clicked any link in the email
- emOpensAll? Signed32 - Total number of non-unique email opens
- emBounces? Signed32 - Number of unique email bounces
- emClicksAllTablet? Signed32 - Number of non-unique email clicks on a small tablet type computer (e.g. iPad)
- emOpensAllMobile? Signed32 - Number of non-unique email opens on a mobile phone or similar small mobile device (e.g. iPhone)
- emAbuse? Signed32 - Number of abuse (spam) complaints received
- emBouncesBlocked? Signed32 - Unique number bounced because as blocked by the receiving system
- emClicksAllNone? Signed32 - Number of non-unique email clicks for which the device type was not captured. This will account for any clicks prior to when device type was collected and stored
- emBouncesOther? Signed32 - Unique number that bounced without an identifiable cause
- emClicksAllComputer? Signed32 - Number of non-unique email clicks on a standard desktop or laptop computer
- emOpensAllNone? Signed32 - Number of non-unique email opens for which the device type was not captured. This will account for any opens prior to when device type was collected and stored
- emOpens? Signed32 - Number of unique recipients who opened the email
- emClicksAllMobile? Signed32 - Number of non-unique email clicks on a mobile phone or similar small mobile device (e.g. iPhone)
- emOpensAllComputer? Signed32 - Number of non-unique email opens on a standard desktop or laptop computer
- emClicksAllOther? Signed32 - Number of non-unique email clicks on an unknown device (e.g. Game Console or Wearable)
- emNotOpened? Signed32 - Number of unique recipients who did not open the email. This is calculated as follows: <code>em_not_opened</code> is equal to <code>em_sends - em_opens - em_bounces</code>. This value is reported as zero if the calculation results in a negative value
- emBouncesNonexistentAddress? Signed32 - Unique number that bounced as a non-existent address
- emBouncesSuspended? Signed32 - Unique number that bounced as suspended. Email address bounces as suspended when multiple non-existent bounces have been received for the same address
- emOpensAllOther? Signed32 - Number of non-unique email opens on an unknown device (e.g. Game Console or Wearable)
- emSends? Signed32 - Number of unique email sends
- emClicksAll? Signed32 - Total number of non-unique email clicks
- emOptouts? Signed32 - Number of unique recipients who unsubscribed due to this email
- emForwards? Signed32 - Number of unique recipients who forwarded the email using the forward to a friend feature (not available for all types of emails)
- emBouncesUndeliverable? Signed32 - Unique number that bounced as undeliverable
- emBouncesMailboxFull? Signed32 - Unique number that bounced back with a mailbox full message
- emOpensAllTablet? Signed32 - Number of non-unique email opens on a small tablet type computer (e.g. iPad)
- emBouncesVacation? Signed32 - Unique number that bounced back with a vacation or out of office autoreply
constantcontact: StatsError
Fields
- errorMessage? string - A error description
- errorKey? string - The unique error key
constantcontact: StatusDisplayLabelDto
Represents a display label for a status with the translation label key
Fields
- label? string - The display text for the status. For example: Available, Sold out
- labelKey? string - The translation key for the status. For example: status_label.available, status_label.sold_out
constantcontact: StreetAddress
Fields
- country? string - The name of the country where the contact lives
- updatedAt? string - Date and time that the street address was last updated, in ISO-8601 format. System generated
- city? string - The name of the city where the contact lives
- kind string - Describes the type of address; valid values are home, work, or other
- street? string - Number and street of the address
- streetAddressId? string - Unique ID for the street address
- createdAt? string - Date and time that the street address was created, in ISO-8601 format. System generated
- state? string - The name of the state or province where the contact lives
- postalCode? string - The zip or postal code of the contact
constantcontact: StreetAddressPut
Fields
- country? string - The name of the country where the contact lives
- city? string - The name of the city where the contact lives
- kind string - Describes the type of address; valid values are home, work, or other
- street? string - Number and street of the address
- state? string - The name of the state or province where the contact lives
- postalCode? string - The zip or postal code of the contact
constantcontact: StructuredTagDto
A structured tag with key, value, and display value
Fields
- displayValue? string - Human-readable display value
- value? string - Tag value
- 'key? string - Tag key
constantcontact: Tag
Fields
- updatedAt? string - The system generated date and time when the tag was last updated (ISO-8601 format)
- name? string - The unique tag name
- tagId? string - The ID that uniquely identifies a tag (UUID format)
- createdAt? string - The system generated date and time when the tag was created (ISO-8601 format)
- contactsCount? int - The total number of contacts who are assigned this tag
- tagSource? string - The source used to tag contacts
constantcontact: TagAddRemoveContacts
Fields
- tagIds string[] - An array of tags (<code>tag_id</code>) to add to all contacts meeting the specified source criteria
- exclude? TagAddRemoveContactsExclude - Use to exclude specified contacts from being added or removed from a tag. Only applicable if the specified source is either <code>all_active_contacts</code> (billable) or <code>list_ids</code>
- 'source TagAddRemoveContactsSource - Select the source used to identify contacts to which a tag is added or removed. Source types are mutually exclusive
constantcontact: TagAddRemoveContactsExclude
Use to exclude specified contacts from being added or removed from a tag. Only applicable if the specified source is either all_active_contacts (billable) or list_ids
Fields
- contactIds? string[] - Identifies the contacts, by <code>contact_id</code>, to exclude from the add or remove tags activity
constantcontact: TagAddRemoveContactsSource
Select the source used to identify contacts to which a tag is added or removed. Source types are mutually exclusive
Fields
- tagIds? string[] - An array of tags ( <code>tag_id</code> )
- newSubscriber? boolean - Use to identify newly subscribed contacts
- contactIds? string[] - An array of contacts IDs
- listIds? string[] - An array of list IDs ( <code>list_id</code> )
- allActiveContacts? boolean - Use to identify contacts with an active (billable) status
constantcontact: TagIdList500Limit
Fields
- tagIds string[] - The tag IDs (<code>tag_ids</code>) to delete
constantcontact: TagPost
Fields
- name string - Specify a unique name to use to identify the tag. Tag names must be at least one character in length and not more than 255 characters
- tagSource? string - The source used to identify the contacts to tag
constantcontact: TagPut
Fields
- name string - The new tag name to use. The tag name must be unique
constantcontact: Tags
Fields
- links? TagsPagingLinks -
- tags? Tag[] - Lists all tags and provides tag details
constantcontact: TagsActivityLinks
Fields
- self? TagsActivityLinksSelf - The link returned in the response that you use to retrieve the status for the specified activity
constantcontact: TagsActivityLinksSelf
The link returned in the response that you use to retrieve the status for the specified activity
Fields
- href? string -
constantcontact: TagsLinks
Fields
- next? ReportingNext -
- href? string -
constantcontact: TagsPagingLinks
Fields
- next? TagsLinks -
constantcontact: TaskCorrelationMetadataDto
Fields
- campaignActivityId? string - Campaign activity identifier
constantcontact: TaskDto
Fields
- metadata? TaskDtoMetadata - Task metadata object
- jsonCondition? record {} -
- kind? string - Task type
- eventCondition? string -
- then? TaskDto[] -
- taskProviderReferenceKey? string -
- script? string -
- timeout? TimeoutDto -
- output? record {} -
- queueName? string -
- input? record { string... } - Task input object
- correlationMetadata? TaskCorrelationMetadataDto -
- retryOptions? TaskDtoRetryOptions -
- 'else? TaskDto[] -
- childTasks? TaskDto[] -
- name? string - Task name
- id? string -
- taskSkipCondition? string -
constantcontact: TaskDtoMetadata
Task metadata object
Fields
- createFromScratch? boolean -
- kind? string -
- action? string -
- list? string -
constantcontact: TaskDtoRetryOptions
Fields
- backoffCoefficient? Signed32 -
- initialInterval? Signed32 -
- maximumAttempts? Signed32 -
constantcontact: TicketSummaryDto
Fields
- ticketType string - The type of ticket
- displayTicketOnPromoRedemption? boolean - Specifies if the ticket on the promo code redemption displays
- associated? boolean - Specifies if the ticket is associated with the promo code
- name string - The name to associate with the ticket
- ticketId? string - The unique identifier for the ticket
- hiddenFlag? boolean - Specifies if the ticket is hidden
constantcontact: TierObject
The usage tier that is associated with a client's Constant Contact account and is used to calculate the monthly billing price
Fields
- tier? Signed32 - The billing tier level that is associated with a client account. By default, the system determines the tier level to use based on the number of active contacts currently in the client account at the time of billing. Billing tiers may differ. The following shows an example billing tier: <ul> <li>level <code>1</code> = 0 - 500 contacts</li> <li>level <code>2</code> = 501 - 1000 contacts</li> <li>level <code>3</code> = 1001 - ...</li> </ul>
- tierMax? float - The maximum number of active contacts for the tier level
- usageType string(default "CONTACTS") - Identifies the tier usage type that is associated with the billing plan
- currentUsage? float - The number of active contacts (default) used within the current tier
- tierMin? float - The minimum number of active contacts for the tier level
- price? float - The billing price set for the tier used to bill the client account each month
- currencyCode? string - The currency (ISO currency code) used to price the tier for a client account
constantcontact: TimeoutDto
Fields
- amount? float - Amount of time for startup timeout
- timeUnit? string - Unit of time for startup timeout
constantcontact: TrackDto
Fields
- restrictToSingleTicketFlag? boolean - Restricts selection to a single ticket
- campaignActivityId string - The campaign activity ID associated with the registration form
- createTime? string - The event's create time
- registrationEndTime? string - The date and time when registration should end. ISO format
- itemsHeader? string - items header
- ticketsHeader? string - The header to use for tickets
- mediaAssets? EventMediaAssetDto[] - The list of media assets configured for the event
- registrationType? string - The registration type for the event
- lastUpdateTime? string - The event's last modification time
- platformFeeScopeType? string - Specifies if the platform fee is passed to registrant or absorbed by the event host
- promoCodes? PromoCodeDto[] - The list of <code>promo_codes</code> configured for the event
- trackId? string - The ticket <code>track id</code>
- confEmailCampaignActivityId? string - The confirmation email campaign activity ID
- overallTicketCapacity? Signed32 - The total overall ticket capacity
- regManuallyClosedFlag? boolean - Closes registration to prevent further registrations
- items? ItemDto[] -
constantcontact: TrackingActivitySmsChannelDTO
Fields
- countryCode? string - The ISO country code that is associated with SMS address
- formattedInternational? string - The formatted SMS number returned if the SMS <code>country_code</code> does not match the contacts <code>country_code</code>.
- state? string - The SMS channel status: <ul><li><code>N</code>: not_set<li> <li><code>T</code>: temp_hold<li> <li><code>P</code>: pending_confirmation<li> <li><code>I</code>: implicit<li> <li><code>E</code>: explicit<li> <li><code>O</code>: unsubscribed<li> <li><code>D</code>:deprecated<li></ul>
- formattedNational? string - The formatted SMS number returned if the SMS <code>country_code</code> matches the contacts <code>country_code</code>.
constantcontact: TriggerDefDto
Defines when the workflow starts (e.g., list join, date-based)
Fields
- engagementLevel? string - Engagement level for engagement_level triggers (e.g., SOMEWHAT, LEAST)
- actionName? string - Action name. Required for type Action or Date. Identifies the specific trigger (e.g., list_join, calendar_date, visits_page)
- bounds? TriggerDefDtoBounds - Time window for Date-type triggers. Sets when the trigger runs relative to
the contact's date. Uses ISO 8601 period format (e.g., P0D, P7D, P-7D).
| Example Scenario | after | before |
|----------|--------|--------|
| On the day |
P0D|P1D| | 7 days before |P-7D|P-6D| | 7 days after |P7D|P8D|
- triggerDate? TriggerDefDtoTriggerDate -
- segmentId? string - Segment ID for segment_join triggers
- 'type? string - Trigger type. Determines how the trigger is evaluated (e.g., Action, Date, segment_join)
- parameters? ParameterDto[] - List of parameters that filter or configure the trigger (e.g., list IDs for list_join)
- uniqueBy? string - Deduplication key: run the workflow at most once per contact per this value (e.g., list_ids, contact_id)
constantcontact: TriggerDefDtoBounds
Time window for Date-type triggers. Sets when the trigger runs relative to the contact's date. Uses ISO 8601 period format (e.g., P0D, P7D, P-7D).
| Example Scenario | after | before |
|---|---|---|
| On the day | P0D | P1D |
| 7 days before | P-7D | P-6D |
| 7 days after | P7D | P8D |
Fields
- before? string - End of the window relative to the contact date in ISO 8601 period format (e.g., P1D = 1 day after, P0D = on the day)
- after? string - Start of the window relative to the contact date in ISO 8601 period format (e.g., P0D = on the day, P-7D = 7 days before)
constantcontact: TriggerDefDtoTriggerDate
Date configuration for Date-type triggers (e.g., birthday, anniversary). Specifies which contact fields supply the date
Fields
- monthField? string - Contact field that contains the month value. Must include 'record.' prefix (e.g., record.birthday_month)
- 'type? string - Where the date is represented (e.g., Profile)
- dayField? string - Contact field that contains the day-of-month value. Must include 'record.' prefix (e.g., record.birthday_day)
- dateField? string - Contact field that contains the full date. Must include 'record.' prefix (e.g., record.anniversary)
constantcontact: TriggerDto
Fields
- triggerDef? TriggerDefDto -
- triggerVersion? string -
- workflowFilter? string -
- triggerFilter? TriggerFilterDto -
constantcontact: TriggerFilterDto
Fields
- rule? TriggerFilterRuleDto -
- version? string - Version number for the trigger filter
constantcontact: TriggerFilterRuleDto
Fields
- left? TriggerFilterRuleDto -
- targetType? string -
- rule? TriggerFilterRuleDto -
- compoundRuleType? string -
- right? TriggerFilterRuleDto -
- 'type? string -
- propertyComparison? PropertyComparisonDto -
- target? string -
constantcontact: UniqueEmailCounts
Fields
- forwards? Signed32 - The total number of unique forwards
- optouts? Signed32 - The total number of unique optouts (unsubscribes)
- abuse? Signed32 - The total number of unique abuse count (spam)
- notOpened? Signed32 - The total number of unique non-opens
- opens? Signed32 - The total number of unique opens
- clicks? Signed32 - The total number of unique clicks
- bounces? Signed32 - The total number of unique bounce count
- sends? Signed32 - The total number of unique sends
constantcontact: UniqueSmsCounts
Fields
- optouts Signed32 - The total number of unique opt-outs (unsubscribes)
- opens? Signed32 - The total number of unique opens
- clicks Signed32 - The total number of unique clicks
- delivers Signed32 - The total number of SMS delivered
- sends Signed32 - The total number of unique sends
constantcontact: UpdateEventRegistrationStatusQueries
Represents the Queries record for the operation: updateEventRegistrationStatus
Fields
- increaseCount? boolean - Override count flag
- increaseItemCount? boolean - Override item count flag
- returnItemsToInventory? boolean - Return items to inventory flag. Defaults to
true
constantcontact: UserPrivilegesResourceInner
Fields
- privilegeId? int - Identifies a user privilege in Constant Contact
- privilegeName? string - The name of the Constant Contact user privilege
constantcontact: WebhooksSubscriptionBody
Fields
- hookUri? string - The callback URI you would like to use to receive webhook notifications. Constant Contact will automatically send POST notifications about your chosen topic to this URI
constantcontact: WebhooksSubscriptionCollectionInner
Fields
- topicDescription? string - A description of what the topic is and when Constant Contact notifies you concerning it
- hookUri? string - Your webhook callback URI. Constant Contact automatically sends POST requests to this URI to notify you about the topic
- topicName? string - The name of the topic
- topicId? int - Identifies the topic using an integer to indicate the type of topic
constantcontact: WebhooksSubscriptionPutResp
Fields
- hookUri? string - Your webhook callback URI. Constant Contact automatically sends POST requests to this URI to notify you about the topic
- topicId? int - Identifies the topic using an integer to indicate the type of topic
constantcontact: WebhooksSubscriptionResponse
Fields
- topicDescription? string - A description of what the topic is and when Constant Contact notifies you concerning it
- hookUri? string - Your webhook callback URI. Constant Contact automatically sends POST requests to this URI to notify you about the topic
- topicName? string - The name of the topic
- topicId? int - Identifies the topic using an integer to indicate the type of topic
constantcontact: WebhooksTestSend
Fields
- topicDescription? string - A description of what the topic is and when Constant Contact notifies you concerning it. When you use the test send API method, Constant Contact will immediately send a test event to you
- hookUri? string - The webhook callback URI. Constant Contact automatically sends POST requests to this URI to notify you about the topic
- topicName? string - The name of the topic
- topicId? int - Identifies the topic using an integer to indicate the type of topic
constantcontact: WorkflowParametersDto
Fields
- automationFlowName? string - Automation flow name
- discountCode? string - Discount code used in discount block
- automationFlowId? string - Automation flow identifier
- campaignId? string - Automation campaign identifier
Array types
constantcontact: EmailScheduleResponse
EmailScheduleResponse
constantcontact: Profiles
Profiles
constantcontact: SmsEngagementHistory
SmsEngagementHistory
constantcontact: ResendToNonOpeners
ResendToNonOpeners
constantcontact: AccountEmails
AccountEmails
constantcontact: EmailSendHistory
EmailSendHistory
constantcontact: WebhooksSubscriptionCollection
WebhooksSubscriptionCollection
An array of webhook subscriptions
constantcontact: UserPrivilegesResource
UserPrivilegesResource
Import
import ballerinax/constantcontact;Metadata
Released date: 1 day ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 42
Current verison: 1
Weekly downloads
Keywords
Vendor/Constant Contact
Area/Marketing & Social Media
Type/Connector
Contributors