Push reservation availability data for a venue. Each request contains slot data for one business across one or more dates.
Key concepts:
Per-date full replacement: Each date you send replaces everything Yelp has for that date. No diffs or patches.
Include booked slots: Send spots_open: 0 for fully-booked time slots so Yelp can distinguish "sold out" from "closed."
15-minute resolution: Slot times must be on 15-minute boundaries (HH:00, HH:15, HH:30, HH:45).
Timezone derived from venue: Yelp determines timezone from the business address. Times in the payload are local to the venue.
Validation is per request: If any date fails validation, the whole request is rejected with 400 and nothing is written. Fix the payload and resend.
Per-date results: A 200 response reports a status for each date. A date with status: error failed on Yelp's side after validation; retry that date.
Prerequisites:
The venue must be registered via the Data Ingestion API with service_type_v2 configuration.
The partner_business_id must match the ID used during DI onboarding.
Authentication: Bearer token via OAuth 2.0 client credentials. Your API key must be whitelisted for this endpoint and linked to a partner ID. Contact your Yelp partner integration representative.
Rate limits: 50 QPS per partner.
Recent Requests
Log in to see full request history
Time
Status
User Agent
Retrieving recent requests…
Loading…
Responses
401
The API key has either expired or doesn't have the required scopes to query this endpoint.
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.
403
Partner API endpoints require set up by Yelp before they can be used. You are trying to access a Partner API endpoint for which your API Client has not been enabled. Please reach out to [email protected] for more information.
404
Partner business not found
429
You 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.
500
Failed to process availability update
504
Upstream timeout
Updated 12 days ago
Did this page help you?
Yes
No
Language
ShellNodeRubyPHPPython
Credentials
Bearer
Bearer
Loading…
Response
Click Try It! to start a request and see the response here! Or choose an example: