workspace

Cancel an ownership recovery

Cancels a pending ownership recovery. Any owner on record, or whoever asked, can cancel it until it completes.

post/workspace/recoveries/{recovery_id}/cancel

Request

  • Base URL: https://localhost:4410/api/v1
  • URL: https://localhost:4410/api/v1/workspace/recoveries/{recovery_id}/cancel
  • Auth: HTTP bearer

Path parameters

recovery_idstring required

Request body

object required

Response

The result.

idstring required
status'pending' | 'cancelled' | 'completed' required
requested_bystring required
requested_by_member_idstring required
new_ownerstring required
new_owner_member_idstring required
document_idstring required
reasonstring required
notice_sent_atstring date-time nullable required
effective_afterstring date-time nullable required
checked_bystring nullable required
checked_atstring date-time nullable required
cancelled_bystring nullable required
cancelled_atstring date-time nullable required
completed_atstring date-time nullable required
can_cancelboolean required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.