HTTP Conventions

HTTP Status Codes

Code	Meaning
200	OK
201	Created
403	Forbidden — you do not have access to this resource (check your Auth/API key)
404	Not found (also returned on bad user credentials)
409	Conflict — auth and structure are OK but there is a problem with the data values
4xx	Client error
5xx	Sheep server error

HTTP Verbs

Verb	Usage
GET	Read a resource
PUT	Update a resource
POST	Create a resource
DELETE	Delete a resource

Note

The system tries to prevent accidental duplicates, so a POST will check before creating. If you need to create a record which the system may consider a duplicate, either send more data to demonstrate uniqueness, or create with unique data and then update. The legacy_uid field is a good field that you can control for this purpose.

API Throttling

sheepCRM reserves the right to modify rate limits at any time. For up-to-date information on rate limits, review the HTTP response headers returned from rate-limited endpoints.

If you receive a rate-limit response, it will include the following headers:

Header	Description
x-rate-limit-limit	The maximum number of requests available in the current time frame (per hour and per minute)
x-rate-limit-remaining	The number of remaining requests in the current time frame
x-rate-limit-reset	The approximate number of seconds until the limit resets

Reading the rate limit string

The rate limit header value looks like:

[ '40, 400;window=60, 1000;window=3600' ]

This means: 40 calls remaining, the per-minute window limit is 400, and the per-hour window limit is 1000.