Success and error confirmation messages
After receiving your API call, Kartra should ping-back a confirmation message upon request: either a success or an error message.
All error or success messages are sent with HTTP response status code 200.
Most of these confirmation messages are usually composed of 3 pieces of information:
- Status of your API call: success or error.
- Short description text message.
- The message type (message ID number) for easy identification.
Below is the full list of errors if your API call fails to establish the connection with our API server:
{ "status": "Error", "message": "Connection not secure", "type": "201" } { "status": "Error", "message": "API key cannot be empty. Please get an API key first", "type": "202" } { "status": "Error", "message": "API key not valid. Please get an API key first", "type": "203" } { "status": "Error", "message": "API password not valid. Please get an API password first", "type": "233" } { "status": "Error", "message": "API Account inactive", "type": "204" } { "status": "Error", "message": "'cmd' is required", "type": "254" } { "status": "Error", "message": "email or lead id is required. Nothing done", "type": "206" } { "status": "Error", "message": "'lead' not an array", "type": "223" } { "status": "Error", "message": "'get_lead' not an array", "type": "236" } { "status": "Error", "message": "'actions' not an array", "type": "224" }
Here are the error messages related to the App itself:
{ "status": "Error", "message": "App Id cannot be empty. Please get an App Id first", "type": "238" } { "status": "Error", "message": "App Id is not valid. The app does not exists or is inactive", "type": "239" } { "status": "Error", "message": "App Account inactive", "type": "240" } { "status": "Error", "message": "This API call was sent from an unauthorized IP", "type": "242" } { "status": "Error", "message": "App does not have permission to execute this CMD", "type": "262" }
The specific actions success and error messages are detailed inside each of the action page itself.