Skip to main content
POST
/
v1
/
devices
Create device
curl --request POST \
  --url https://api.clinikapi.com/v1/devices \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "deviceName": "<string>",
  "manufacturer": "<string>",
  "modelNumber": "<string>",
  "serialNumber": "<string>",
  "lotNumber": "<string>",
  "manufactureDate": "<string>",
  "expirationDate": "<string>",
  "type": "<string>",
  "patientId": "<string>",
  "ownerId": "<string>",
  "locationId": "<string>",
  "url": "<string>",
  "note": "<string>",
  "parentId": "<string>",
  "udiCarrier": [
    {
      "deviceIdentifier": "<string>",
      "carrierHRF": "<string>"
    }
  ],
  "safety": [
    "<string>"
  ]
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
deviceName
string
required
Maximum string length: 500
status
enum<string>
Available options:
active,
inactive
manufacturer
string
Maximum string length: 500
modelNumber
string
Maximum string length: 200
serialNumber
string
Maximum string length: 200
lotNumber
string
Maximum string length: 200
manufactureDate
string
expirationDate
string
type
string
Maximum string length: 200
patientId
string
Maximum string length: 128
ownerId
string
Maximum string length: 128
locationId
string
Maximum string length: 128
url
string
Maximum string length: 2000
note
string
Maximum string length: 5000
parentId
string
Maximum string length: 128
udiCarrier
object[]
Maximum array length: 10
safety
string[]
Maximum array length: 20
Maximum string length: 200

Response

201

Device created