Skip to main content

Create/update webhook configuration

Create or update your webhook configuration to use the webhook feature

PUT http://api.cmtelecom.com/bulkemail/v1.0/accounts/{accountID}/webhooks

PUT Parameters​

NameInDescriptionRequiredTypeExample
AccountIDPathThe account guidTrueGuidA8C062E4-ECFD-48D0-89B1-A37D2622B7A9
BodyBodyThe new webhook configurationTrueJson objectSee example request
X-CM-PRODUCTTOKENHeaderYour product tokenTrueGuidC24A5029-37DD-4161-9728-F80D8639588E
Example request
{
"Url": "https://cm.com",
"Settings": {
"Sent": true,
"Unsubscribe": true,
"Delivered": true,
"Complaint": true,
"Bounced": true,
"Blacklisted": true,
"Opened": true,
"ViewedInBrowser": true,
"Clicked": true,
"PermanentBounced": true
}
}

Responses​

Http statusDescription
200Webhook configured
400Bad request
Example response
{
"AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9",
"Url": "https://cm.com",
"Settings": {
"Sent": true,
"Unsubscribe": true,
"Delivered": true,
"Complaint": true,
"Bounced": true,
"Blacklisted": true,
"Opened": true,
"ViewedInBrowser": true,
"Clicked": true,
"PermanentBounced": true
},
"CreatedOn": "2019-02-01T14:07:15.423",
"CreatedOnUtc": "2019-02-01T13:07:15.423Z",
"ModifiedOn": "2019-02-01T14:07:15.423",
"ModifiedOnUtc": "2019-02-01T13:07:15.423Z",
"DeletedOn": null,
"DeletedOnUtc": null
}