Add New Client Appointment

curl --location -g --request POST 'https://.daftra.com/api2/client_appointments' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "FollowUpReminder": { "item_id": 0, "staff_id": "if it is integer then this points to the staff who created the appointment", "date": "2019-08-24T14:15:22Z", "end_date": "2019-08-24T14:15:22Z", "body": "string", "action_id": 0, "status": 0, "status_date": "2019-08-24T14:15:22Z", "post_id": 0, "recurring": 0, "partner_type": "CLIENT => 1", "partner_id": 0, "share_with_partner": 0 } }'

Request

Path Params

format

string

required

Header Params

string

optional

Default:

application/json

Content-Type

string

optional

Default:

application/json

Authorization

string

optional

You can generate the bearer token using the the authorization endpoint then use it here to be able to operate over your account's data

Default:

Bearer {{access_token}}

apikey

string

deprecated

You can find/generate your apikey(s) from inside your Daftra Account

Default:

Body Params application/json

FollowUpReminder

object

AppointmentBase

optional

item_id

integer <int32>

required

Ref # of the id for that item ex:( if the it is client_appointment then item_id should be client_id )

staff_id

<int32>

optional

Staff user submitting the request get it from GET STAFF API if it's 0 that means the site owner is the staff that created it

Allowed values:

if it is integer then this points to the staff who created the appointmentif it is array then this points to the assigned staffs and the staff who created the appointment will be the system

date

string <date-time>

required

date of the appointment

end_date

string <date-time> | null

optional

end date of the appointment

body

string

optional

Text body for the appointment

action_id

integer <int32>

optional

Action to be performed get it from GET Follow Up Actions API with the appointment type`

status

enum<integer> <int32>

optional

Status of current appointment status

Allowed values:

0 => Scheduled1 => Done2 => Dismissed

Default:

status_date

string <date-time>

optional

When the status was updated to the current state.

post_id

integer <int32>

optional

Post REF#, you can get it through the Notes API if equals 0 then it has no post

Default:

recurring

enum<boolean>

write-onlyoptional

0/1 indicates whether this appointment is repeated or not

Allowed values:

0 => not repeated1 => repeated

Default:

partner_type

enum<integer> <int32>

required

Type of the appointment partner.

Allowed value:

CLIENT => 1

partner_id

integer <int32>

required

Ref # of the appointment partner id ex:( if the partner then partner_id should be client_id )

share_with_partner

boolean

optional

0/1 indicates whether this appointment is shared with the partner or not

Default:

Examples

Created

Add New Client Appointment

Request

Responses