Our v3 API is now available! Learn more by visiting the v3 developer portal. Creating new v2 API keys is no longer supported.

Individual Partner Webhooks - View, Subscribe, Unsubscribe

Use this endpoint to view (GET), subscribe to (PUT) or unsubscribe from (DELETE or PUT) a Partner Webhook topic.

NOTE: This partner-only endpoint uses basic authentication as documented on this page.

Methods:

Click a method to view its documentation

GET PUT DELETE

DescriptionTOP

Cancel an existing account using the PUT method to change the account status to Cancelled. You must include the cancel_date in ISO-8601 format. You can also specify a cancel_reason for your records.

Here's the list of cancel_reason codes to use, along with their meanings:

Code Description
1 Cost Too High
2 Using A Competitive Service
3 Not Doing Email Marketing
11 Something Missing Or Not Working
12 Doing It In-House
14 Poor Results
21 Too Difficult To Use
27 Cancelled online by customer
30 Dissatisfied With Billing Policies

DescriptionTOP

Privileges required: contacts:lists:write

PUT: Update the name, status of the ContactList specified by the listId path parameter. Performing a PUT overwrites all existing properties for the contactlist resource; any properties left blank or not included in the call will delete those property values prior to the call.

DescriptionTOP

Privileges required: mylibrary:folder:update

Use PUT to modify the following properties for a folder specified by folderId path parameter:

  • update the folder's name
  • change the folder's location in the directory structure by changing it's parent_id
    To move a folder to level 1 in the directory structure, set the parent_id to 0

DescriptionTOP

Privileges required: mylibrary:file:update

Use a PUT call to update the following for a file (specified using the fileId path parameter):

  • Update the name
  • Update the description
  • Move a file to another folder, using folder_id to specify the destination folder.

DescriptionTOP

Privileges required: campaign:write

Update an existing event by using the eventId path parameter. 

DescriptionTOP

Privileges required: campaign:write

Update an existing event item; specify the event and the item using the eventId and itemId path parameters.

DescriptionTOP

Privileges required: campaign:write

Update an existing promocode for an event; specify the code and event using the eventId and promocodeId path parameters.

DescriptionTOP

Privileges required: campaign:write

Update an existing fee (specify using feeId) for an event specified by eventId.

DescriptionTOP

Privileges required: campaign:write

Update an existing item attribute by specifying the eventId, itemId, and attributeId path parameters. Include the attribute name and description in the JSON request body. 

NOTE: You cannot change an attribute name once any have been sold to or claimed by event registrants.

DescriptionTOP

Privileges required: campaign:activate

Update the schedule for an email campaign using the scheduleId and campaignId path parameters.

PUT: https://api.constantcontact.com/v2/webhooks/partner/topics/{topicId}

name

type

default

description

api_key

query

REQUIRED; The API key for the application; key must have Partner level API Access

topicId

path

Unique ID for the partner webhook topic

Example JSON Request BodyTOP

{
    "is_subscribed":true,
    "callback_uri":"https://wwww.example.com/webhook/billingTier"
}

Response CodesTOP

code

description

200

Successfully subscribed to the topic

400

Either JSON was malformed or there was a data validation error

401

Authentication failure

404

The specified topicId does not exist

406

Unsupported accept header value, must be application/json

415

Unsupported content-type in the header, must be application/json

500

Internal server error occurred

StructureTOP

property

type(max length)

description

Example ResponseTOP

{
    "name" : "Billing Tier Change Upgrade",
    "description" : "Executes when an account's billing tier is increased",
    "is_subscribed" : true,
    "callback_uri" : "https://www.example.com/webhook/billingTier"
 }