Documentation Index
Fetch the complete documentation index at: https://pingback.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Error schema
We use standard HTTP response codes for success and failure notifications, and our errors are further classified by type.MISSING_BODY
- Status: 400
- Message: Body is necessary.
- Suggested action: Ensure that the request body is not empty.
FORBIDDEN
- Status: 403
- Message: User is not authorized to access this resource with an explicit deny in an identity-based policy.
- Suggested action: Make sure the API key is correct or generate an API key.
CONTACT_NOT_FOUND
- Status: 404
- Message: Contact not found.
- Suggested action: Check if the contact exists before using it.
SEGMENTATION_LIST_NOT_FOUND
- Status: 404
- Message: Segmentation list not found.
- Suggested action: Check if the segmentation list exists before using it.
DEAL_NOT_FOUND
- Status: 404
- Message: Deal not found.
- Suggested action: Check if the deal exists before using it.
PIPELINE_NOT_FOUND
- Status: 404
- Message: Pipeline not found.
- Suggested action: Check if the pipeline exists before using it.
STAGE_NOT_FOUND
- Status: 404
- Message: Stage not found.
- Suggested action: Check if the stage exists before using it.
CONTACT_ALREADY_EXISTS
- Status: 409
- Message: Contact already exists.
- Suggested action: Check if the contact already exists before creating a new one.
CONTACT_ASSOCIATED_WITH_A_DEAL
- Status: 409
- Message: Contact already associated with a deal.
- Suggested action: Check if the contact already already associated with a deal before creating or updating one.
INVALID_INPUT
- Status: 422
- Message: Invalid
JSONbody. - Suggested action: Ensure that the request body is valid, and all required fields are present.
INVALID_PARAMS
- Status: 422
- Messages:
DEAL_ID_IS_NECESSARYCONTACT_EMAIL_IS_NECESSARYEMAIL_IS_NECESSARY
- Suggested action: Ensure that the deal id, contact email or email is present in the request.
TOO_MANY_REQUESTS
- Status: 429
- Message: Too many requests.
- Suggested action: To prevent this, we recommend reducing the rate at which you request the API. This can be done by introducing a queue mechanism or reducing the number of concurrent requests per second. If you have specific requirements, contact our support team.
INTERNAL_SERVER_ERROR
- Status: 500
- Message: An unexpected error occurred.
- Suggested action: Try the request again later. If the error does not resolve, contact our support team.