Errors

Error envelope

{
  "success": false,
  "error": "Human-readable message"
}

Common status codes

Rate limits

Limits are enforced per Partner API key (falling back to IP when no key identity is present), and are keyed by HTTP method + route pattern.

• Most GET reads: 60 requests / minute
• Typical writes (POST/PATCH/PUT/DELETE): 10–30 / minute depending on the route
• Calendar bookings: 20 / minute
• Money-sensitive ops (lead-order pause/cancel/patch, Voice AI cancel/wallet): stricter caps (about 5–30 / minute)
• Token renew (POST /api/v2/auth/token/renew): 10 / minute per IP

Reduce parallel polling and cache availability or list responses where you can. See individual operation pages under Resources for endpoint details.

Example messages

• Invalid or missing token
• Token missing required scope: contacts
• Invalid date range. Use YYYY-MM-DD for from and to.
• Date range must be between 1 and 90 days inclusive.
• first_name and last_name are required
• phone is required
• This time slot is no longer available.
• Contact not found