Create default

Creates a default value, or replaces the value of the row with the same key. The key is default-object, default-field, reseller, and domain; each one you leave out is *. Send reseller for a territory row, domain for a domain row, and neither for a system row.

Who can write:

Super User writes every tier. Only Super User writes system rows (reseller and domain both *).

Reseller writes its territory's rows (reseller set to your territory) and rows of domains in its territory.

Office Manager and Route Manager write their own domain's rows.

Route Manager Reseller, Call Center Supervisor, Office Manager Read-Only, Site Manager, Super User Read Only, and user scopes get 403.

default-object is domain, user, device, or *, and is stored lowercase. default-field must be a field GET /defaults/objects/{object}/fields lists for that object (for *, a field of any of the three); credentials, scope, and key fields (domain, user, device, reseller, territory) can't carry a default. Keys and value are held to their lengths. Anything else returns 400 before the change is published. default-value is up to 255 characters; a number is stored as its string form.

The change is checked, then published over the service bus (SBUS) and applied on every server shortly after, so 202 means accepted, not yet stored. Read the row back to confirm it. Send domain and reseller in the body: in the query string they're ignored.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

application/json

The default passed every check and was published over the service bus (SBUS); it is applied shortly after: {"code": 202, "message": "Accepted"}.

Bodyapplication/json

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/defaults' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "default-object": "domain", "default-field": "time-zone", "reseller": "example-reseller", "default-value": "America/New_York" }'

Request

Responses