API Status Code Responses - Shape Software - Automate your business!

Instructions

Shape Software API

  • Introduction
  • Using Shape APIs
  • Status Codes
  • Rate Limits

POST API Calls

GET API Calls

Status Code API Responses

Status Code Definitions

The Shape API uses HTTP Status codes to reflect a successful or unsuccessful request. 2XX status codes represent a successful request, 4XX status codes represent an error took place. If you receive an error status code, check the body for an error code and message.

 

Successful Request                         200

This means, that the request was received and understood and is being processed.

 

Bad Request                                    400

User error. This can mean that a required field or parameter has not been provided, the value supplied is invalid, or the combination of provided fields is invalid.

 

Unauthorized                                 401

Invalid/missing credentials. This can mean that a required API authorization key or parameter has not been provided, the value supplied is invalid, or the combination of provided fields is invalid.

 

Not Found                                       404

Not Found. The resource doesn’t exists, ex. invalid/non-existent lead id

 

Conflict                                             409

Conflict. Occurs when trying to overwrite a resource, ex. when creating an event with a time conflict

 

Limit Exceeded                                429

Rate Limit Exceeded. This occurs when the limit is exceeded, an API request will fail and an error status code will be returned.

How to Get Field Names

Field names can be found within your CRM System’s settings pages under: Settings > Marketing Sources > Edit Any Marketing Source > Campaign Source Post URL Instructions.

 

After navigating to the marketing sources settings page and opening up a campaign, scroll to the bottom of the page to the “Campaign Source Post URL Instructions” section. Here, you will find a searchable table with a breakdown of all of the field names available for use. These field names can also be exported to a CSV via the “Export” dropdown.