warden

API reference

Limits

The request allowance for a key, and the size limits on a request and on each field.

Requests

A key may make 60 requests a minute. A request counts once however many records it carries, so a 500 record write, a dry run and one page of a list are one each.

Past the allowance, Warden answers 429 with rate_limited and a Retry-After header in seconds, and writes nothing. Send your batches one after another and honor Retry-After. A reconcile of a few thousand members needs a handful of requests.

Sizes

Limit
Records in one sync500
Records in one page of a list500, and the default
Identities in one record50
Days an invitation lasts1 to 90, 30 by default
What a member adds through an invitation20 shops, profiles or websites
Shops in one shop-status request500

Field lengths

Text is trimmed before it is measured.

FieldCharacters
external_id200
status200
tier200
credential.holder_name200
credential.title80
credential.registration_id64
identities[].source80
identities[].handle200
identities[].url600
shop-status url500

Freshness

A record kept current by an integration is treated as stale after 72 hours without a sync. Its public page then says the current status is not verified. See Keep it current.