Update Webhook (webhook - UpdateWebhook)
Update Webhook.
/** * Webhook::UpdateWebhook * * Update a webhook * unspecified parameters are not changed * * id [int, required - int]: id of webhook to be modified * event [open|click|bounce|unsubsribe|complaint, optional]: event type * url [string, optional]: url to catch event posts * name [string, optional]: webhook identifier, unique for user * enabled [bool, optional]: enable the webhook */ { "username": "matbt@pinpointe.com", "usertoken": "***", "requesttype": "Webhook", "requestmethod": "UpdateWebhook", "details": { "id": "{*int*}", /* required */ "event": "{*event_type*}", "url": "{*url*}", "name": "{*name*}", "enabled": "{*bool*}" } }
JSON Request Example:
json_request element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Webhook |
requestmethod | UpdateWebhook |
details element
Field Name | Description |
id (required) | Webhook id that needs tested |
event | Type of event (open, click, bounce, unsubscribe, complaint) |
url | URL to catch event posts |
name | Unique name for webhook |
enabled | Enable the webhook (TRUE, FALSE) |
Successful Response
response element
Field Name | Description |
status | Returns SUCCESS when successful |
Unsuccessful Response
response element
Field Name | Description |
status | Returns FAILED when unsuccessful |
errormessage | Text explaining why webhook deletion failed |