Skip to main content
PUT
/
calendar-notes
/
{calendarNote}
Update note
curl --request PUT \
  --url https://api.postflow.app/v1/calendar-notes/{calendarNote} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "organization_id": "<string>",
  "user_id": "<string>",
  "group_id": "<string>",
  "title": "<string>",
  "content": "<string>",
  "color": 1,
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "end_date_extra_day": "2023-11-07T05:31:56Z",
  "visible_for_client": true,
  "is_private": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
calendarNote
string
required

The calendar note ID

Body

application/json
​
title
string
required
Maximum string length: 100
​
start_date
string<date-time>
required
​
end_date
string<date-time>
required
​
group_id
string | null

If group_id is provided, the note will be visible only within that group. If it is null, the note is visible across all groups.

​
content
string | null
Maximum string length: 500
​
color
enum<integer>

1 Red
2 Green
3 Blue
4 Yellow
5 Orange
6 Pink
7 Purple
8 Sky
9 Gray

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9
​
is_private
boolean

Note will be visible only to you.

​
visible_for_client
boolean

Note will be also visible to clients.

Response

CalendarNoteData

​
id
string
required
​
organization_id
string
required
​
user_id
string | null
required

The ID of the user who created the calendar note

​
group_id
string | null
required

If group_id is provided, the note is visible only within that group. If it is null, the note is visible across all groups

​
title
string | null
required
​
content
string | null
required
​
color
enum<integer>
required

1 Red
2 Green
3 Blue
4 Yellow
5 Orange
6 Pink
7 Purple
8 Sky
9 Gray

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9
​
start_date
string<date-time>
required
​
end_date
string<date-time>
required
​
end_date_extra_day
string<date-time>
required
​
visible_for_client
boolean
required

If true, the note is also visible to clients

​
is_private
boolean
required

If true, the note is visible only to the author