Skip to main content
POST
/
v1
/
locations
Create location
curl --request POST \
  --url https://api.clinikapi.com/v1/locations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "type": [
    "<string>"
  ],
  "alias": [
    "<string>"
  ],
  "phone": "<string>",
  "email": "[email protected]",
  "address": {
    "line": [
      "<string>"
    ],
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "physicalType": "<string>",
  "position": {
    "longitude": 123,
    "latitude": 123,
    "altitude": 123
  },
  "managingOrganizationId": "<string>",
  "partOfId": "<string>",
  "hoursOfOperation": [
    {
      "daysOfWeek": [],
      "allDay": true,
      "openingTime": "<string>",
      "closingTime": "<string>"
    }
  ],
  "availabilityExceptions": "<string>"
}
'
{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "issues": [
    {
      "severity": "<string>",
      "code": "<string>",
      "diagnostics": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
name
string
required
Maximum string length: 500
status
enum<string>
Available options:
active,
suspended,
inactive
description
string
Maximum string length: 2000
mode
enum<string>
Available options:
instance,
kind
type
string[]
Maximum array length: 10
Maximum string length: 200
alias
string[]
Maximum array length: 10
Maximum string length: 200
phone
string
Maximum string length: 20
email
string<email>
Maximum string length: 200
address
object
physicalType
string

Physical form (building, wing, room, bed, vehicle)

Maximum string length: 200
position
object

GPS coordinates

managingOrganizationId
string

Organization that manages this location

partOfId
string

Parent location ID

hoursOfOperation
object[]
Maximum array length: 20
availabilityExceptions
string
Maximum string length: 2000

Response

Location created