Add multiple regions

curl --request POST \
  --url https://api.example.com/v2/regions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "config": {}
}'

{
  "config": {}
}

API Reference

Add multiple regions

Add multiple regions to the authenticated legal entity. Providing the employee count will configure the region and generate applicable tasks. The employee count is expected to consist of all current full time employees.

Example

Request

    "config": {
        "AL": {"employee_count": 1},
        "AK": {"employee_count": 10},
    }
}

POST

regions

Add multiple regions

curl --request POST \
  --url https://api.example.com/v2/regions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "config": {}
}'

{
  "config": {}
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

A dictionary mapping state codes to their respective platform region configurations. The key for the dictionary is the StateCode which is the 2 character state code. To view the entire list of supported state codes, see StateCode enum.

config

Config · object

required

A dictionary with two character state code as key and regional configuration as value.

Show child attributes

Response

A successful response will contain the dictionary containing regions, with employee counts. For a successful response, this will match the request.

config

Config · object

required

A dictionary with two character state code as key and regional configuration as value.

Show child attributes

List Regions Add region

⌘I

V2

Authorizations

Body

Response