Skip to content

edit.md

Latest commit

 

History

History
181 lines (130 loc) · 3.18 KB

edit.md

File metadata and controls

181 lines (130 loc) · 3.18 KB

Edit User Calendar

Edits an existing calendar for a specific user.

URL : /api/v1/calendars/:user_id/:calendar_id

Method : PUT or PATCH

Auth required : YES

Params constraints

:user_id -> "[user id as an int]",
:calendar_id -> "[numeric id of a calendar owned by the user]",

Request Body constraints

{
	"name": "[string: calendar name, alphanumeric, spaces, underscores and hyphens, max 64 chars]",
	"description": "[string: calendar description, alphanumeric, spaces, underscores and hyphens, max 256 chars, optional]",
	"events_support": "[string: 'true' or 'false', default 'true', optional]",
	"notes_support": "[string: 'true' or 'false', default 'false', optional]",
	"tasks_support": "[string: 'true' or 'false', default 'false', optional]"
}

URL example

/api/v1/calendars/jdoe/1

Body example

{
	"name": "Updated Work Calendar",
	"description": "Updated calendar for work events",
	"events_support": "true",
	"notes_support": "true",
	"tasks_support": "false"
}

Success Response

Code : 200 OK

Content examples

{
	"status": "success",
	"timestamp": "2026-01-23T15:01:33+01:00"
}

Error Response

Condition : If 'X-Davis-API-Token' is not present or mismatched in headers.

Code : 401 UNAUTHORIZED

Content :

{
	"message": "No API token provided",
	"timestamp": "2026-01-23T15:01:33+01:00"
}

or

{
	"message": "Invalid API token",
	"timestamp": "2026-01-23T15:01:33+01:00"
}

Condition : If user is not found.

Code : 404 NOT FOUND

Content :

{
	"status": "error",
	"message": "User Not Found",
	"timestamp": "2026-01-23T15:01:33+01:00"
}

Condition : If request body contains invalid JSON.

Code : 400 BAD REQUEST

Content :

{
	"status": "error",
	"message": "Invalid JSON",
	"timestamp": "2026-01-23T15:01:33+01:00"
}

Condition : If ':calendar_id' is not owned by the specified ':username'.

Code : 400 BAD REQUEST

Content :

{
	"status": "error",
	"message": "Invalid Calendar ID",
	"timestamp": "2026-01-23T15:01:33+01:00"
}

Condition : If calendar instance is not found.

Code : 404 NOT FOUND

Content :

{
	"status": "error",
	"message": "Calendar Instance Not Found",
	"timestamp": "2026-01-23T15:01:33+01:00"
}

Condition : If 'name' parameter is invalid (not matching the regex or exceeds length).

Code : 400 BAD REQUEST

Content :

{
	"status": "error",
	"message": "Invalid Calendar Name",
	"timestamp": "2026-01-23T15:01:33+01:00"
}

Condition : If 'description' parameter is invalid (not matching the regex or exceeds length).

Code : 400 BAD REQUEST

Content :

{
	"status": "error",
	"message": "Invalid Calendar Description",
	"timestamp": "2026-01-23T15:01:33+01:00"
}

Condition : If no calendar components are enabled (all of events_support, notes_support, and tasks_support are false).

Code : 400 BAD REQUEST

Content :

{
	"status": "error",
	"message": "At least one calendar component must be enabled (events, notes, or tasks)",
	"timestamp": "2026-01-23T15:01:33+01:00"
}