Modify configuration

PATCH
https://api.octopush.com/v1/public/user/campaign-parameters/edit

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

NameTypeDescription
sms_campaign_alert_parametersarrayTable with alert parameters.
alert_typestringType of SMS to decide the alert threshold.
alert_boundintegerWarning threshold.
alert_email_tostringE-mail address to which to send alerts.
alert_phone_number_tostringMobile phone number to send alerts to.
campaign_parametersarrayTable with campaign parameters.
sender_for_sms_premiumstringDefault sender for your SMS campaigns. 3 to 11 alphanumeric characters.
sender_for_vocal_smsstringDefault sender for your voice campaigns. 3 to 11 numeric characters.
phone_number_for_test_smsstringDefault phone number presented when creating a campaign on your online interface.
callbacksarrayTable containing callback URLs.
callback_url_for_sms_deliveriesstringURL where you would like to receive AR SMS callbacks.
callback_url_for_blacklisted_numbersstringURL where you would like to receive unsubscribe requests (stops).
callback_url_for_vocal_sms_deliveriesstringURL where you would like to receive callbacks from AR SMS Vocal.
callback_url_for_inboundsstringURL where you would like to receive inbound SMS callbacks.
email_for_inboundsstringEmail address to which you would like incoming SMS 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": "my_email@email.com",
    "alert_phone_number_to": "+336971433333"
  },
  "campaign_parameters": {
    "sender_for_sms_premium": "12345",
    "sender_for_vocal_sms": "12345",
    "phone_number_for_test_sms": "+3356478465456"
  },
  "callbacks": {
    "callback_url_for_inbounds": "https://mywebhook.dns/webhook-1",
    "callback_url_for_sms_deliveries": "https://mywebhook.dns/webhook-2",
    "callback_url_for_blacklisted_numbers": "https://mywebhook.dns/webhook-3",
    "callback_url_for_vocal_sms_deliveries": "https://mywebhook.dns/webhook-4",
    "email_for_inbounds": "my_email@email.com"
  }
}'

JSON Server Response

Success : 200 OK