Locations

Create a location

This endpoint is designed to by used by My Brandtrack users.

post/v2/locations

Request

Headers

x-customer-api-keystring

Request body

namestring required

Must not be greater than 100 characters.

countrystring required

The <code>iso</code> of an existing record in the countries table. Must be 2 characters.

citystring required

Must not be greater than 100 characters.

addressstring required

Must not be greater than 255 characters.

zip_codestring required

Must not be greater than 20 characters.

phone_numberstring required

Must not be greater than 40 characters.

emailstring required

Must be a valid email address. Must not be greater than 100 characters.

managerstring required

Must not be greater than 255 characters.

type'own' | 'franchise' required
additional_informationstring nullable

Must not be greater than 1024 characters.

Example request

{
  "name": "ojpraplsvntmeldpdkmp",
  "country": "cl",
  "city": "qdddkgyxbjgquhfvasy",
  "address": "hveyqazuvntjbbskxezycdto",
  "zip_code": "jvxfuvlanyjkwggywkw",
  "phone_number": "blfyghkjmrvkjofiajevi",
  "email": "lindsey52@example.com",
  "manager": "sfkrcbygpvexfpx",
  "type": "franchise",
  "additional_information": "aqlgoitxfc"
}

Response

Success

Example response

{
  "data": {
    "id": 26440,
    "account_id": 19120,
    "name": "Downtown Bakery",
    "country": "US",
    "address": "176 Berry St, Brooklyn",
    "phone_number": "11002929",
    "email": "john.doe@brandtrack.fm",
    "manager": "John Doe",
    "created_at": "2024-07-31T14:38:34+00:00",
    "timezone": "America/Los_Angeles",
    "type": "own",
    "city": "New York",
    "zip_code": "11249",
    "additional_information": null
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.