Locations

Create a location

Create a location.

POST

/business/locations

Create a location

curl --request POST \
  --url https://api-example.kickcall.ai/api/v1/business/locations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location": {
    "address_attributes": {
      "city": "<string>",
      "country": "<string>",
      "platform_language": "<string>",
      "postal_code": "<string>",
      "state": "<string>",
      "street_address": "<string>",
      "time_zone": "America/New_York"
    },
    "business_hours": {},
    "contact_email": "<string>",
    "contact_name": "<string>",
    "contact_phone": "<string>",
    "holidays": [
      {}
    ],
    "name": "<string>",
    "physical_location_exists": true,
    "user_ids": [
      123
    ]
  }
}
'

{
  "address": {
    "city": "Toronto",
    "country": "CA",
    "platform_language": "en",
    "postal_code": "M5V 2T6",
    "state": "ON",
    "street_address": "100 Main St",
    "time_zone": "America/Toronto"
  },
  "agents": [
    {
      "id": 980,
      "name": "Alex"
    }
  ],
  "business_hours": {
    "monday": {
      "close": "17:00",
      "open": "09:00"
    }
  },
  "business_id": 286,
  "contact_email": "downtown@acme.example",
  "contact_name": "Front Desk",
  "contact_phone": "+14165550101",
  "holidays": [],
  "id": 340,
  "name": "Downtown",
  "physical_location_exists": true,
  "user_ids": [
    91,
    92
  ]
}

Audience: Business portal. Auth: Business/agency JWT or API key; usually header Business-Id. Resource: Locations.

Authorizations

Authorizationstringheaderrequired

JWT from OTP login, or business/agency API key string.

Body

locationobjectrequired

Show child attributes

Response

Created — Created location

addressobject

Show child attributes

agentsobject[]

business_hoursobject

business_idinteger

contact_emailstring

contact_namestring

contact_phonestring

holidaysobject[]

idinteger

namestring

physical_location_existsboolean

user_idsinteger[]

Still need help? Ask the team