Skip to content
Home » Octopush Gateway SMS API » API Sub-Accounts » Modify a subaccount

Modify a subaccount

PATCH
https://api.octopush.com/v1/public/subaccount/*****@sub-accounts.com/edit

Encoding : UTF-8

Authentification

Your “api-key” and “api-login” identifiers must be added in the headers.

Definition

This service allows you to edit the fields of a sub-account.

Special parameters

NameTypeDescription
first_namestringFirst name to be associated with the sub-account.
last_namestringLast name to be associated with the sub-account.
passwordstringSub-account password
company_namestring(optional) Company name.
callbacksobjectObject containing callback URLs.
callback_url_for_deliveriesstringURL where you would like to receive DR callbacks.
callback_url_for_blacklisted_numbersstringURL where you would like to receive unsubscribe requests (stops).
callback_url_for_visitsstringURL where you would like to receive callbacks for visits.
callback_url_for_inboundsstringURL where you would like to receive inbound messages callbacks.
email_for_inboundsstringEmail address to which you would like incoming messages to be forwarded.

Curl Example

curl -X PATCH \ 
'https://api.octopush.com/v1/public/subaccount/*****@sub-accounts.com/edit' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "first_name":"Leonardo",
  "last_name": "Da Vinci",
  "company_name": "Italy",
  "password": "**********",
  "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]"
  }
}'

Command to copy/paste

curl -X PATCH 'https://api.octopush.com/v1/public/subaccount/*****@sub-accounts.com/edit' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"first_name":"Leonardo", "last_name": "Da Vinci", "company_name": "Italy", "password": "**********", "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]"}}'

JSON Server Response

Success : 201 OK