Daftra API

Edit Notes

Production

https://{{subdomain}}.daftra.com/api2

PUT

/notes/{id}{format}

Notes

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT 'https://.daftra.com/api2/notes/' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Note": {
        "id": 0,
        "item_type": 0,
        "item_id": 0,
        "date": "2019-08-24T14:15:22Z",
        "staff_id": 0,
        "body": "string",
        "action_id": 0,
        "status_id": 0
    },
    "FollowUpReminder": {}
}'

Response Example

200 - Example 1

{
  "code": 200,
  "result": "successful"
}

Request

Path Params

string

required

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

Note

object

NoteBase

optional

integer <int64>

optional

Unique identifier

item_type

integer <int32>

optional

Type of the post ( 1 for client appointment ).

item_id

integer <int32>

optional

Ref # of the id for that type ex:( if the item_type = 1 then item_id should be client_id )

date

string <date-time>

optional

Date of the post

staff_id

integer <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

body

string

optional

Text body of the post( can contain HTML )

action_id

integer <int32>

optional

Action Ref #

status_id

integer <int32>

optional

Status Ref # of the post

FollowUpReminder

object

optional

Examples

Responses

🟢200OK

application/json

Body

code

integer

optional

Example:

200

result

string

optional

Example:

successful

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

GET Single Note

Delete Notes