PATCH
https://api.octopush.com/v1/public/user/campaign-parameters/editEncoding : UTF-8
Authentication
Your “api-key” and “api-login” must be added in the headers.
Definition
Allows you to change your default configuration for SMS campaigns.
Special parameters
| Name | Type | Description | |
|---|---|---|---|
sms_campaign_alert_parameters | object | Object with alert parameters. | |
alert_type | string | Type of SMS to decide the alert threshold. | |
alert_bound | integer | Warning threshold. | |
alert_email_to | string | E-mail address to which to send alerts. | |
alert_phone_number_to | string | Mobile phone number to send alerts to. | |
campaign_parameters | object | Object with campaign parameters. | |
sender_for_sms_premium | string | Default sender for your SMS campaigns. 3 to 11 alphanumeric characters. | |
sender_for_voice_sms | string | Default sender for your voice campaigns. 3 to 11 numeric characters. | |
phone_number_for_test_sms | string | Default phone number presented when creating a campaign on your online interface. | |
callbacks | object | Object containing callback URLs. | |
callback_url_for_deliveries | string | URL where you would like to receive DR of the messages that you sent. | |
callback_url_for_blacklisted_numbers | string | URL where you would like to receive unsubscribe requests (stops). | |
callback_url_for_visits | string | URL where you would like to receive callbacks for each visit on one of your landing page. | |
callback_url_for_inbounds | string | URL where you would like to receive inbound message callbacks. | |
email_for_inbounds | string | Email address to which you would like incoming messages to be forwarded. |
Curl Example
curl -X PATCH \
'https://api.octopush.com/v1/public/user/campaign-parameters/edit' \
-H 'Content-Type: application/json' \
-H 'api-key: ************' \
-H 'api-login: ******@email.org' \
-H 'cache-control: no-cache' \
-d '{
"sms_campaign_alert_parameters": {
"alert_type": "sms_low_cost",
"alert_bound": 150,
"alert_email_to": "[email protected]",
"alert_phone_number_to": "+336971433333"
},
"campaign_parameters": {
"sender_for_sms_premium": "12345",
"sender_for_voice_sms": "12345",
"phone_number_for_test_sms": "+3356478465456"
},
"callbacks": {
"callback_url_for_inbounds": "https://mywebhook.dns/webhook-1",
"callback_url_for_deliveries": "https://mywebhook.dns/webhook-2",
"callback_url_for_blacklisted_numbers": "https://mywebhook.dns/webhook-3",
"callback_url_for_visits": "https://mywebhook.dns/webhook-4",
"email_for_inbounds": "[email protected]"
}
}'