Create new Exchange Area
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Create new Exchange Area

  • Dark
    Light
  • PDF

Article summary

Post
/exchange-areas/

Operation is used to create new exchange area. Available from product version 3.2.8.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Exchange Area to be created

object

Exchange Area

id
integer

Primary key

name
string Required

Area name

Responses
201

created Exchange Area data

{
  "id": 4358950,
  "name": "test-area"
}
object

Exchange Area

id
integer

Primary key

name
string

Area name

400

There was an error in request. Usually field validation failed.

{
  "name": [
    "This field is required.",
    "This field must be unique."
  ]
}
object

Fields which failed validation

property*
Array of string additionalProperties

List of validation errors for this fieldname

string

Validation error

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error


Was this article helpful?