PATCH

/v1/patients/{id}

Authorization*
curl --request PATCH \
  --url https://api.opkit.co/v1/patients/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json'
{
  "collection_page_url": "string",
  "created_at": "string",
  "date_of_birth": "2022-07-21",
  "email": "string",
  "first_name": "string",
  "id": "string",
  "last_name": "string",
  "reference_id": "string",
  "sex_assigned_at_birth": "male",
  "source": "collection_page",
  "state_of_residence": "alabama",
  "zip_code": "string"
}

Authorizations

Authorizationheaderrequired
string

The Opkit API uses the HTTP Bearer Token scheme for authentication. You should provide your API key in the Authorization header like so: "Authorization: Bearer [api-key]".

Path Parameters

idrequired
string

Body

application/json
date_of_birth
string | null
email
string | null
first_name
string | null
last_name
string | null
reference_id
string | null
sex_assigned_at_birth
enum<string> | null
Available options:
male,
female
state_of_residence
enum<string> | null
Available options:
alabama,
alaska,
arizona,
arkansas,
california,
colorado,
connecticut,
delaware,
florida,
georgia,
hawaii,
idaho,
illinois,
indiana,
iowa,
kansas,
kentucky,
louisiana,
maine,
maryland,
massachusetts,
michigan,
minnesota,
mississippi,
missouri,
montana,
nebraska,
nevada,
new_hampshire,
new_jersey,
new_mexico,
new_york,
north_carolina,
north_dakota,
ohio,
oklahoma,
oregon,
pennsylvania,
rhode_island,
south_carolina,
south_dakota,
tennessee,
texas,
utah,
vermont,
virginia,
washington,
west_virginia,
wisconsin,
wyoming
zip_code
string | null

Response

200 - application/json
collection_page_urlrequired
string
created_atrequired
string
date_of_birth
string
email
string
first_name
string
idrequired
string
last_name
string
reference_id
string
sex_assigned_at_birth
enum<string>
Available options:
male,
female
sourcerequired
enum<string>
Available options:
collection_page,
dashboard,
api
state_of_residence
enum<string>
Available options:
alabama,
alaska,
arizona,
arkansas,
california,
colorado,
connecticut,
delaware,
florida,
georgia,
hawaii,
idaho,
illinois,
indiana,
iowa,
kansas,
kentucky,
louisiana,
maine,
maryland,
massachusetts,
michigan,
minnesota,
mississippi,
missouri,
montana,
nebraska,
nevada,
new_hampshire,
new_jersey,
new_mexico,
new_york,
north_carolina,
north_dakota,
ohio,
oklahoma,
oregon,
pennsylvania,
rhode_island,
south_carolina,
south_dakota,
tennessee,
texas,
utah,
vermont,
virginia,
washington,
west_virginia,
wisconsin,
wyoming
zip_code
string