Create a region

POST /api/accounts/{account_id}/regions
Api key

Allows you to create a new region in the system. Available to Garmat and customer administrators.

Path parameters

  • account_id string Required

    The ID of the account to assign the region to

application/json

Body

The parameters to create a region

  • account_id string

    ID of the account to assign the region to

  • name string Required

    name of the region to create

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • account_id string

      ID of the account the region belongs to

    • booth_count number

      Number of booths associated to this region

    • facility_count number

      Number of facilities associated to this region

    • id string

      ID of the region in the system

    • name string

      Name of the region
  • 400 application/json

    Bad request

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code
  • 401 application/json

    Unauthorized

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code
POST /api/accounts/{account_id}/regions 
curl \
 --request POST 'http://localhost:4000/api/accounts/{account_id}/regions' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Test Region","account_id":"a9299bca-acc2-4dde-1111-83a08ca12128"}'
Request examples 
{
  "name": "Test Region",
  "account_id": "a9299bca-acc2-4dde-1111-83a08ca12128"
}
Response examples (200) 
{
  "id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
  "name": "Test Region",
  "account_id": "a9299bca-acc2-4dde-1111-83a08ca12128"
}
Response examples (200) 
{
  "id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
  "name": "Test Region",
  "account_id": "a9299bca-acc2-4dde-1111-83a08ca12128"
}
Response examples (400) 
{
  "error": "Error Reason"
}
Response examples (400) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}