Skip to main content
POST
/
v1
/
appointment-responses
Create appointment response
curl --request POST \
  --url https://api.clinikapi.com/v1/appointment-responses \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "appointmentId": "<string>",
  "actorId": "<string>",
  "participantType": "<string>",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "comment": "<string>"
}
'

Authorizations

​
x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
​
appointmentId
string
required

The appointment this response relates to

​
participantStatus
enum<string>
required
Available options:
accepted,
declined,
tentative,
needs-action
​
actorId
string

The participant (Patient, Practitioner, etc.)

​
participantType
string

Role of participant in the appointment

​
start
string<date-time>

Proposed new start time

​
end
string<date-time>

Proposed new end time

​
comment
string
Maximum string length: 2000

Response

201

Appointment response created