Cancel Request Endpoint

post

https://api.joinplanbase.com/api/v1/requests/cancel

Withdraw one or more pending requests. Same body as POST /approve; every item is treated as decision=cancelled. Does not notify. Pass validate_only=true to run the same checks without writing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

validate_only

boolean

Defaults to false

Run cancel checks without persisting

Body Params

items

array of objects

required

length ≥ 1

One or more request payloads. Items and requested_entries for the same person whose windows fall in the same work week are submitted together so weekly rules apply to the full week.

Items*

One request to create or approve/deny. It is an approval when resource_id points
at a row that already has a pending request and decision is not pending; otherwise
it is a create.

type

string

enum

required

Allowed:

resource_id

Shift / unavailability id, or synthetic negative id for availability. Required for modify_, cancel_ and any approve/deny. Omit for a new time_off or availability. For claim_shift this is the open shift id.

person_id

Person the request is for. Required when there is no resource_id; otherwise read off the row.

start

Label time; derived from the resource or first requested_entry when omitted

requested_entries

array of objects

Proposed / desired entries. Empty for cancels and for plain time_off approvals.

Requested Entries

decision

string

enum

Defaults to approved

pending submits as a pending request. approved submits as approved (validation may still drop it to pending) or approves a pending request. denied denies a pending request. cancelled withdraws a pending request (a deny by the requester).

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error