Create an office

This endpoint lets you create new offices for a given organization_reference.

This endpoint requires offices_rw scope.

new office

POST https://www.welcomekit.co/api/v1/external/offices

Query Parameters

Name	Type	Description
organization_reference*	string	Organization reference
name*	string	Name
address	string	Address
zip_code	string	Zip code
city*	string	City
country_code*	string	Country code
is_headquarter	boolean	Office is organization headquarter?

200 Success

{
  "id": 42,
  "name": "Paris",
  "address": "11 bis rue Bachaumont",
  "zip_code": "75002",
  "city": "Paris",
  "country_code": "FR",
  "is_headquarter": true
}

Request example

curl -X POST "https://www.welcomekit.co/api/v1/external/offices" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer WK_API_KEY" \
    -d @- <<EOF
{
  "organization_reference": "Pg4eV6k",
  "name": "Paris",
  "address": "11 bis rue Bachaumont",
  "zip_code": "75002",
  "city": "Paris",
  "country_code": "FR",
  "is_headquarter": true
}
EOF