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.
Click a method to view its documentation
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 |
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.
Privileges required: mylibrary:folder:update
Use PUT to modify the following properties for a folder specified by folderId
path parameter:
name
parent_id
parent_id
to 0Privileges required: mylibrary:file:update
Use a PUT call to update the following for a file (specified using the fileId
path parameter):
name
folder_id
to specify the destination folder.
Privileges required: campaign:write
Update an existing event by using the eventId
path parameter.
Privileges required: campaign:write
Update an existing event item; specify the event and the item using the eventId
and itemId
path parameters.
Privileges required: campaign:write
Update an existing promocode for an event; specify the code and event using the eventId
and promocodeId
path parameters.
Privileges required: campaign:write
Update an existing fee (specify using feeId
) for an event specified by eventId
.
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.
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 |
{ "is_subscribed":true, "callback_uri":"https://wwww.example.com/webhook/billingTier" }
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 |
property |
type(max length) |
description |
---|
{ "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" }