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

Privileges required: contacts:lists:write

Delete the contact list specified by the listId path parameter.

DescriptionTOP

Privileges required: mylibrary:folder:delete

Delete a MyLibrary folder specified by the folderId path parameter.

DescriptionTOP

Privileges required: mylibrary:file:delete

Delete one or more MyLibrary files specified by the fileId path parameter, separate multiple file IDs with a comma. Deleted files are moved from their current folder into the system Trash folder, and its status is set to Deleted. To permanently delete a file, you must empty the Trash folder.

DescriptionTOP

Privileges required: campaign:write

Delete an event item by using the eventId and itemId path parameters to specify the event and item.

DescriptionTOP

Privileges required: campaign:write

Delete an existing promocode specified using the promocodeId path parameter.

DescriptionTOP

Privileges required: campaign:write

Delete an existing fee (specified by feeId) for an event (specified by eventId). An event is required to have a minimum of 1 fee. You cannot delete a fee if it is the only fee for the event specified. 

DescriptionTOP

Privileges required: campaign:write

Delete an existing event item attribute. Use the eventId, itemId, and attributeId path parameters to specify the attribute to delete.

DescriptionTOP

Privileges required: campaign:stop

Delete the email campaign schedule specified by the campaignId and scheduleId path parameters.

DescriptionTOP

Privileges required: campaign:delete

Deletes the email campaign specified by the campaignId path parameter.

NOTE: You cannot delete a campaign with a status=SCHEDULED.

DescriptionTOP

Privileges required: contacts:write

Using the DELETE method on a contact resource changes the contact's status to OPTOUT, which means that you can no longer send campaigns to this contact. Delete/OPTOUT a contact specified using the contactId path parameter. Learn more about contact status here.

DELETE: 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

Response CodesTOP

code

description

204

Successfully unsubscribed from the topic, no content returned

401

Authentication failure

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