Skip to main content

cancel_user_request

The requester withdraws a request that hasn't been quoted yet. It moves the request to CANCELED, a final status, in the status flow. This call is unchanged by this release.

It is a GraphQL mutation returning UserRequest. Only the user who created the request can call it, and only while the request is PENDING or IN_CHARGE. Once a quote exists, use decline_user_request instead.

Input​

input: UserRequestInput!

FieldTypeRequiredDescription
idStringYesThe user request to cancel.
Mutation
mutation {
cancel_user_request(input: { id: "3JMY..." }) { id status }
}

Errors​

ErrorMeaning
<status>_user_requestThe request is past IN_CHARGE — for example issued_user_request.
unauthorizedThe caller didn't create the request.
not_foundUnknown id.

It can also return Middleware Errors.