Regions: CreateRegion

This method creates a new region. When you create a region, you specify only the name. The service will assign and return a region ID (regionId) and a creation timestamp (createdDate).

Request

HTTP request

POST /v2/accounts/{accountId}/regions

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The id of the account.

Request Body

region

Responses

CodeDescriptionReference
201

The region was successfully created

Region
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Regions::CreateRegion

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

Region

Contains information about a region.

regionIdinteger

The id of the region. This is the id that the system generated when you created the region.

namestring

The name of the office.

createdDatestring

The UTC date and time when the item was created. This is a read-only value that the service assigns.

Example: 2019-07-17T17:45:42.783Z

}} />