Accounts

Update an account

Updates an Account

Path parameters

idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Account update params
brand_namestringOptional
The name by which the people this account communicates with know it. If not provided, this will match the name field.
namestringOptional

The name of the account that will be visible for your internal organizational purposes. This will also be the default public-facing brand name unless you also set a brand_name, but otherwise the account name will never be displayed anywhere outside of Surge HQ, and may include your ID for the account or anything else that may help you.

organizationobjectOptional
Parameters describing the legal entity on whose behalf the account will be operated.
time_zonestring or nullOptional
The time zone for the account

Response

Account
brand_namestring or null
The name by which the people this account communicates with know it. If not provided, this will match the name field.
idstring
The account ID
namestring

The name of the account that will be visible for your internal organizational purposes. This will also be the default public-facing brand name unless you also set a brand_name, but otherwise the account name will never be displayed anywhere outside of Surge HQ, and may include your ID for the account or anything else that may help you.

organizationobject
The legal entity on whose behalf the account will be operated.
time_zonestring or null
This is the time zone in which the account is headquartered. This time zone may be used for compliance with TCPA restrictions on when messages may be sent.