Skip to main content
POST
/
v1
/
persons
Create person
curl --request POST \
  --url https://api.clinikapi.com/v1/persons \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "phone": "<string>",
  "email": "[email protected]",
  "birthDate": "<string>",
  "address": {
    "line": [
      "<string>"
    ],
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "photo": {
    "url": "<string>",
    "data": "<string>",
    "contentType": "<string>"
  },
  "managingOrganizationId": "<string>",
  "active": true,
  "link": [
    {
      "targetId": "<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
firstName
string
required
Maximum string length: 100
lastName
string
required
Maximum string length: 100
phone
string
Maximum string length: 20
email
string<email>
Maximum string length: 200
gender
enum<string>
Available options:
male,
female,
other,
unknown
birthDate
string

Date of birth (YYYY-MM-DD)

address
object
photo
object
managingOrganizationId
string

Managing organization ID

active
boolean
Maximum array length: 20

Response

Person created