API Rate Limits - Shape Software - Automate your business!

Instructions

Shape Software API

POST API Calls

GET API Calls

API Rate Limits

Rate Limits

Rate Limits define the maximum number of requests that can be made by apps to the Shape REST API in a given period of time. Shape employs rate limits to ensure stability of the API service for all users and to prevent many types of abuse or inadvertent usage.

 

Rate limits are applied at the account level. Rate limits will be shared by all apps created and installed on an account. When the limit is exceeded, an API request will fail and an HTTP 429 status code will be returned.

APIs are grouped by Request Type, with unique rate limits for each. A “Rate Limit Label” will be added on each section in our API Reference documentation for each endpoint.

Some APIs have restrictions on concurrent operations performed at the resource level (for example: simultaneous updates to a single userID).

 

Use the tables below to understand how rate limits are applied:

 

POST /lead/add/calendar/event

1 Request/Second

 

POST /add/new/lead

1 Request/Second

 

 POST /change/lead/status

1 Request/Second

 

GET /get/lead/status

1 Request/Second

 GET /get/statuses

1 Request/Second

 

GET /search/lead

1 Request/Second

Best Practices for Handling Errors

When you exceed the rate limits allowed for an API request, you will receive a “429 Too Many Requests” error. The best way to handle rate limits is to be on the lookout for 429 status codes and build in a retry mechanism that makes reduced number of requests to the server in a given timeframe.

 

Cache responses whenever possible instead of frequently making the same request. We also highly recommend that you use Webhooks instead of polling for changes whenever applicable. Instead of making repeated calls to pull data frequently from the Shape API, you can use Webhooks to get information on events that happen in Shape.

 

To prevent abuse and handle API request traffic efficiently, we may alter these limits if required.