Identifying rate limits
Recognize the rate limits that apply to Retention Messaging API endpoints, and handle them in your code.
Overview
The Retention Messaging API limits the number of requests that you can submit to each endpoint within a specified timespan. The request limits apply per app.
The following table lists the rate limits for each endpoint in the production environment, expressed in requests per second. The system enforces rate limits on an hourly basis.
Endpoint | Rate limit (per second) |
|---|---|
10 | |
1 | |
1 | |
1 | |
1 | |
1 | |
1 | |
1 | |
1 | |
1 | |
1 | |
1 | |
1 | |
1 |
The rate limits in the sandbox environment are 10% of the limits in the table above.
The App Store server may make adjustments to reduce or increase these rate limits as needed at any time.
Handle exceeded rate limits gracefully
If you exceed a per-hour limit, the API rejects the request with an HTTP 429 response with a RateLimitExceededError object in the body. Consider the following as you integrate the API:
If you periodically call the API, throttle your requests to avoid exceeding the per-hour limit for an endpoint.
Manage the
HTTP429RateLimitExceededErrorresponse in your error-handling process. For example, log the failure and queue the job to process it again at a later time.Check the
Retry-Afterheader if you receive theHTTP429error. This header contains a UNIX time, in milliseconds, that indicates when you can next send a request.