API contract notes

The endpoint reference describes Bual Pro's published Swagger contract, checked on 19 October 2026. The specification does not cover every integration detail.

Identifier types

Keep the type documented for the endpoint you are using. The source is inconsistent for custom_field_id, contact_id, template_id, and product_id across some operations. Confirm accepted values before assuming the same type applies everywhere.

For GET /pipelines/{pipeline_id}/custom_fields, the source omits the definition of pipeline_id. The reference represents the required route placeholder as an unconstrained URL string so it can be displayed. Its actual identifier type is unconfirmed.

Missing response bodies

These operations have response descriptions without a response body schema:

• POST /contacts
• POST /contacts/{contact_id}/send/{flow_id}
• POST /contacts/{contact_id}/send_content
• POST /contacts/{contact_id}/ai/save_messages
• POST /contacts/{contact_id}/send/products

A missing schema does not mean the response body is empty. Confirm the actual response before depending on fields that are not documented.

Media types and examples

Some operations do not declare request or response media types. Where JSON is used to display their schemas, the endpoint notes identify that omission. Confirm the required Content-Type and actual response media type before integrating.

Examples generated from a schema show possible structure. Only values explicitly included in the source are source examples; none are recorded live results from a business account.

List limits and pagination

The custom-field contact search describes a maximum of 100 contacts, sorted by the last custom-field value update. Pipeline, opportunity, and comment list endpoints document their own offset and limit parameters. Use the parameters shown for each endpoint.

Three source response arrays include an invalid maximum annotation with the value 100. The reference retains that value as a source note without inventing an enforced array-length constraint.

Rate limits and error handling

The specification does not define a general rate-limit policy, retry interval, or platform-wide 429 response contract. It also does not establish a common error body for every endpoint. Check the responses documented on the individual operation and confirm any additional requirements with Bual Pro.

Calendar details

The calendar-details route is GET /calendars/{calendar_id} and references the Calendar model. Its old product wording and duplicate operation identifier have been corrected in this reference. The API route and parameters are unchanged.