Skip to content
Without a Worry

Errors and limits

Error codes, safe retries and rate limits.

Updated View as markdown

Errors

Every error has the same shape:

{
  "error": {
    "code": "invalid_input",
    "message": "Check the supplied fields, values and date order.",
    "request_id": "c2a1f0e3-4b5d-4c6e-8f7a-9b0c1d2e3f4a"
  }
}

The X-Request-Id header carries the same request ID. Include it when you contact WaW about a failed request.

Status Code What to do
400 invalid_json Send a JSON object with Content-Type: application/json.
401 invalid_key Check the key and the environment.
403 access_revoked The connection is no longer active. Contact WaW.
403 subscription_required The customer’s WaW subscription or trial has ended.
404 not_found The route does not exist, or the record is not in this customer’s team.
405 method_not_allowed Use POST on the collection and PATCH on a single record. See the Allow header.
409 reference_conflict This external_id already exists with different data. Use PATCH to change it.
413 body_too_large Keep the body under 16 KiB.
422 invalid_input Check field names, values, lengths and date order. Unknown fields are rejected.
422 invalid_contact The contact_id is not in this customer’s team.
429 rate_limited Wait for the number of seconds in Retry-After.
500 internal_error Retry later. If it keeps failing, send WaW the request ID.

Retries

Creates are safe to retry. WaW links each external_id to one record per customer team.

  • The same create request again returns 200 with the existing IDs. The order of JSON keys does not matter.
  • A create with the same external_id but different data returns 409. Use PATCH instead.
  • When the customer has deleted the record, or moved it to another team, a retry returns 404. WaW does not recreate it.

PATCH requests are safe to repeat as well: sending the same change twice gives the same result.

Rate limits

Each customer key allows 60 requests per minute, shared across all four routes. The budget resets every minute. When you go over it, you get 429 with a Retry-After header in seconds.

Size limits

Item Limit
Request body 16 KiB
external_id 128 characters
name, first_name, last_name 300 characters
email 320 characters
phone 50 characters
location, lost_reason 1.000 characters

Responses are never cached.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close