To manage follow-up Sequences via API in Papo, you can list the available cadences, enroll contacts, and pause a lead’s participation using custom attribute updates — all through authenticated requests, without opening the dashboard. This is how you integrate lead nurturing with CRMs, ERPs, and external automation workflows.
Summary of API operations
| Operation | Description | How the API performs it |
|---|---|---|
| List sequences | Get all follow-up cadences in the account, with name, identifier, and status (active/inactive). | Authenticated GET request to the flows endpoint, filtering by the "sequence" type. |
| Enroll contact | Insert an existing contact into an active sequence, starting the message journey. | POST with the contact ID and sequence ID to the enrollment endpoint. |
| Pause cadence for a contact | Temporarily stop sends to a lead without removing them from the sequence. | Update the contact’s custom attribute (e.g., status_pausa) via the contacts API, combined with a condition in the Flow. |
How authentication and endpoints work
All operations use Papo’s REST API, authenticated with the account’s secret key (Bearer token). The base URL is https://app.papo.global/api/v1. Keys are generated in the dashboard, in the developer area.
Sequence resources are grouped under the flows endpoints. The API allows you to list all flows, including those of the "sequence" type, and also activate/deactivate an entire flow. To enroll a contact, there is a specific endpoint that receives the contact identifier and the flow identifier.
The exact details of each endpoint (parameters, payloads, and examples) are available in Papo’s official API documentation. Here, we focus on the workflow for managing follow-up sequences.
Step by step: list, enroll, and pause
1. List the available sequences
Before enrolling leads, you need to know which sequences exist and their identifiers. The list call returns a relation with name, ID, and status (active/inactive). Only active sequences accept new enrollments.
With the list in hand, your external system can map which sequence to use for each lead.
2. Enroll a contact in a sequence
With the contact ID (obtained via search or creation through the contacts API) and the active sequence ID, you send a request to insert the contact at the start of the journey. The contact must exist in Papo’s CRM; otherwise, create it first using the contacts endpoint.
Enrollment immediately starts sending the scheduled messages, respecting the intervals configured in the Flow. The contact’s history is preserved.
3. Pause the cadence for a specific contact
Papo’s API does not have a direct command to "pause" a contact’s participation in a sequence. However, you can achieve the same effect by combining the contacts API with a condition in the Flow.
Prerequisite: the sequence must have been built with a condition node that checks a custom attribute (e.g., status_pausa). If the attribute equals "paused", the condition blocks sending the next messages; otherwise, it allows them. (See the article on temporary pause for details on setting up the Flow.)
With this structure in the Flow, pausing is done in two steps via API:
- Identify the contact by ID or search for them by phone/email using the contacts listing endpoint.
- Update the contact’s custom attribute to "paused" (or the value your condition expects). Use the contact update endpoint, sending the custom field.
From that moment on, when the flow reaches the condition, it will identify the "paused" value and will not send the message. To resume, simply update the attribute to any other value (e.g., "active") or clear it, and the contact will continue where they left off.
This method keeps the contact enrolled and the progress in the cadence, without losing history.
Who this integration is useful for
- SDR and B2B sales operations that trigger sequences from external events (e.g., a lead downloaded a resource, a deal was created in the CRM).
- White label resellers that automatically provision follow-up journeys for new customers, enrolling initial contacts without manual action.
- Marketing and automation teams that use tools like n8n or Zapier to connect Papo to dozens of systems and need granular control over cadences.
- Companies with conditional pause processes, where a lead asks for time and the salesperson wants to interrupt the sequence without losing the cadence point — all triggered by a button in the external CRM.
Frequently asked questions
Do I need the secret key to list sequences?
Yes. Every operation that returns account data requires authentication with the secret key, sent as a Bearer token in the Authorization header.
Can I enroll a contact that does not yet exist in Papo?
No. The contact must exist in Papo’s CRM. You can create it first via the contacts API (with name, phone, or email) and then enroll it in the sequence.
Does the API allow removing a contact from the sequence?
Removal (canceling enrollment) is not available as a specific endpoint in the current version. The alternative for stopping sends is to pause via a custom attribute, as described, or to deactivate the entire flow, which affects all contacts.
How do I know whether the pause by attribute worked?
After updating the attribute, the sequence will continue processing the wait nodes. When it reaches the condition, it will check the value. If it is "paused", the message will not be sent. You can confirm in the contact profile, in the Contacts module, that the contact remains enrolled, but the next messages are not triggered.
Can I pause the entire sequence via API?
Yes. The API allows you to change a flow’s status to inactive, pausing the sequence for all contacts. Use the flow activation/deactivation endpoint. To resume, simply reactivate it.
Where can I find the exact endpoints and code examples?
The complete API documentation is available at https://papo.global/pt/docs. There you will find the flows and contacts endpoints and the request formats.
Read also
- How to use the Papo API to manage automation Flows
- How to use the Papo API to create and update contacts in bulk
Start for free and automate your sequences →
With the Papo API, you integrate lead nurturing directly into your stack, without opening the dashboard — the first user is free for you to test.