With an API key or as a partner: cancel only. Send status: cancelled and a
cancellation_reason. The client is emailed that the appointment was cancelled; the
email promises nothing about money. Cancelling moves no money.
- API key (the vendor's own, or a partner key naming the vendor in
X-Vendor-Code):
needs theappointments:managescope. A key cannot refund:refund: trueis refused
with 403 and nothing is cancelled. Refunds are made from the portal. - Partner staff (partner portal session naming the vendor in
X-Vendor-Code): need
the partner permissionedit appointment(owners and admins by default). Choosing
refund: truealso needs the partner permissionrefund appointment(owners by
default).
Any other field, or any status other than cancelled, is refused for these callers
with 403 and nothing changes.
Vendor staff (portal) can also change the staff member, shift, appointment type,
location and attachments, and mark an appointment completed, with the edit appointment
permission.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
401Unauthenticated
403A key without appointments:manage; a partner staff member without edit appointment
(Insufficient permissions); anything but a cancel from a key or a partner
(Partners and API keys can only cancel an appointment here.); a refund with an API
key (Refunds cannot be made with an API key. Refund from the portal.); a refund
without the refund appointment permission; or an invalid vendor assignment.
404Appointment not found, or X-Vendor-Code names no vendor of yours (OYS-PARTNER-1001)
422Validation error, an appointment that is not scheduled or in progress, or a refund that cannot be made (the message says why; nothing was cancelled)