Cancel a visit

post

https://api.yelp.com/v3/visits/{visit_id}/cancel

Cancel an on-my-way or a waitlist visit by the given encrypted visit identifier.

Curl example with OAuth authentication:

    root@test:~# curl -X POST "https://api.yelp.com/v3/visits/{VISIT_ID}/cancel" --header 'accept: application/json' --header "Authorization: Bearer ${API_TOKEN}"

If the visit is canceled successfully, the client will receive an empty 204 response.

Note: In order to use this endpoint, the caller should be an onboarded Yelp Waitlist partner

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

code	description
UNAUTHORIZED_API_KEY	The API key provided is not currently able to query this endpoint.
TOKEN_INVALID	Invalid API key or authorization header.

204The visit is canceled successfully

400Bad Request. Message varies depending on failure scenario

401The API key has either expired or doesn't have the required scopes to query this endpoint. codedescriptionUNAUTHORIZED_API_KEYThe API key provided is not currently able to query this endpoint.TOKEN_INVALIDInvalid API key or authorization header.

404Resource Not Found

409This error is returned in any of the following scenarios: Statuserror_codeReason409VISIT_ALREADY_IN_TERMINAL_STATEThis visit was already in a terminal state or the customer is not in queue

429You have either exceeded your daily quota, or have exceeded the queries-per-second limit for this endpoint. Try reducing the rate at which you make queries.

500Internal Server Error

503Service Unavailable