v1

latestOpenAPI 3.0.22026-07-1481521.0 KB
Configuration

Change Account Settings

Update the default webhook URLs associated with your account:

  • Callback URL for incoming SMS messages
  • Callback URL for delivery receipts

Note that the URLs you provide must be valid and active. Vonage will check that they return a 200 OK response before the setting is saved.

post/account/settings

Query parameters

api_keystring required
Example:abcd1234

Your Vonage API key. You can find this in the dashboard

api_secretstring required
Example:ABCDEFGH01234abc

Your Vonage API secret. You can find this in the dashboard

Response

OK. Settings were updated if supplied, the details of the current settings are included in the response.

dr-callback-urlstring url

The current or updated delivery receipt webhook URI

max-calls-per-secondinteger

The maximum number of API calls per second.

max-inbound-requestinteger

The maximum number of inbound messages per second.

max-outbound-requestinteger

The maximum number of outbound messages per second.

mo-callback-urlstring url

The current or updated inbound message webhook URI

Example response

{
  "dr-callback-url": "https://example.com/webhooks/delivery-receipt",
  "max-calls-per-second": 30,
  "max-inbound-request": 30,
  "max-outbound-request": 30,
  "mo-callback-url": "https://example.com/webhooks/inbound-sms"
}