---
title: "Gong Engage API capabilities"
slug: "gong-engage-api-capabilities"
updated: 2026-04-29T14:05:34Z
published: 2026-04-29T14:05:34Z
canonical: "help.gong.io/gong-engage-api-capabilities"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://help.gong.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Gong Engage API capabilities
> **Who can use this**: Tech admin, Business admin
>
> **Available on**: Gong Engage
The Gong Engage API lets you manage, and customize Engage flows at scale. With these endpoints, you can list available flows and folders, assign or unassign prospects, and override flow content to tailor messaging for specific campaigns or workflows. This article walks through the available API capabilities, including the scopes required and examples of how to use them.
**API endpoints for Engage flows:**
- List Gong Engage flows (/v2/flows)
- List Gong Engage flow folders (/v2/flows/folders)
- List assigned flows for the given prospects (/v2/flows/prospects)
- Assign prospects (contacts or leads) to an Engage flow (/v2/flows/prospects/assign)
- Unassign flows by CRM Prospect ID (/v2/flows/prospects/unassign-flows-by-crm-id)
- Unassign flows by Flow Instance ID (/v2/flows/prospects/unassign-flows-by-instance-id)
[See API docs](https://gong.app.gong.io/settings/api/documentation#post-/v2/flows/prospects/unassign-flows-by-instance-id)
## List Gong Engage flows (/v2/flows)
**get** /v2/flows
This endpoint returns all company flows, plus personal flows and flows shared with the user specified in the **flowEmailOwner** parameter. Flows in deleted or inaccessible folders are not returned.
Engage flows have the following visibility types:
- **Company**. Visible to everyone in the company, can only be edited by users with edit permissions.
- **Personal**. Reps can set up their own flows, which are only available to them.
- **Shared**. Reps can share a flow with other reps. Those reps can then add leads to the flow.
When accessed through a Bearer token authorization method, use the **api:flows:read** scope.
[See API docs](https://gong.app.gong.io/settings/api/documentation#get-/v2/flows)
## List Gong Engage flow folders (/v2/flows/folders)
**get** /v2/flows/folders
This endpoint returns all company flow folders, plus personal flow folders and flow folders shared with the user specified in the **flowEmailOwner** parameter.
Engage flow folders have the following visibility types:
- **Company**. Visible to everyone in the company, can only be edited by users with edit permissions.
- **Personal**. Reps can set up their own flow folders, which are only available to them.
- **Shared**. Reps can share a flow folders with other reps. Those reps can then add flows to the flow folder.
When accessed through a Bearer token authorization method, use the **api:flows:read** scope.
[See API docs](https://gong.app.gong.io/settings/api/documentation#get-/v2/flows/folders)
## List assigned flows for the given prospects (/v2/flows/prospects)
**post** /v2/flows/prospects
Get the Gong Engage flows assigned to the given prospects.
When accessed through a Bearer token authorization method, this endpoint requires the scope **api:flows:read**.
[See API docs](https://gong.app.gong.io/settings/api/documentation#post-/v2/flows/prospects)
## Assign prospects (contacts or leads) to an Engage flow (/v2/flows/prospects/assign)
**post** /v2/flows/prospects/assign
Use this endpoint to assign several prospects to a flow. Prospects can be contacts or leads in your CRM.
Generate a list of comma-separated CRM IDs of the prospects you want to add to a flow. The **flowInstanceOwnerEmail** parameter is the email address of the Gong user who set up the flow instance and is assigned to the flow to-dos. You can assign up to 100 prospects to a flow in a single request. If the specified flowId does not exist or the flow has been deleted, the endpoint returns HTTP 404.
Both this endpoint and /v2/flows/prospects/assign/cool-off-override return HTTP 404 when the flowId is invalid or the flow blueprint is not found.
When accessed through a Bearer token authorization method, this endpoint requires the scope **api:flows:write**.
[See API docs](https://gong.app.gong.io/settings/api/documentation#post-/v2/flows/prospects/assign)
### Overriding flow content
You can override the content of each step in a flow instance, including:
- **Subject** for all to-do types (emails, call scripts, and more)
- **Body** for all to-do types (emails, call scripts, and more)
- **Field placeholder values** used in subjects or bodies. Insert custom content without replacing the entire template, and create and use [custom field placeholders](/v1/docs/set-up-and-manage-field-placeholders#custom-field-placeholders)
- **Flow description**, which is especially useful for flows that are triggered automatically. This helps ensure reps have the necessary context to understand their tasks and who they’re engaging with.
.png?sv=2026-02-06&spr=https&st=2026-10-15T11%3A00%3A30Z&se=2026-10-15T12%3A00%3A30Z&sr=c&sp=r&sig=PMDVSOaPQ73038Z5cdobIcpvg%2BeO2ZAjDKCHsKTaV%2FU%3D)
#### Override flow instance-specific step content
- **Step number**. The number of the flow instance step you want to override
- Example: '1'
- If the flow instance step number is not provided, the default step chosen should be step '1'
- **Subject**. The subject line of a flow instance step
- Can use field placeholders
- Example: '{{mycompany}}/{{account_name}} Initial Call'
- **Body HTML**. The HTML used to populate the body of a flow instance step
- Can use HTML
- Can use field placeholders
- Example: 'Hello {{first_name}}
'
#### Specify flow instance-specific field placeholder values
List field placeholders that are already part of the subject, body, or flow description, and provide their values in advance.
- Can use HTML
- Example:
- Field palceholder key: {{first_name}}
- Field placeholder Value: “”
- Although field placeholders consist of a word or two, they can also consist of full HTML rich text paragraphs. For example:
- Field placeholder key: {{value_proposition}}
- Field placeholder value: We’re on a mission to empower companies to unlock their full revenue potential.
We help everyone on revenue teams improve productivity, increase predictability, and drive revenue growth by deeply understanding customers and business trends and taking impactful actions.
#### Override flow instance flow description
To override the description for a specific flow instance.
- Can use HTML
- A text paragraph
- Example: Your goal for this flow is to schedule a follow-up conversation with event attendees to gather feedback, answer questions about Gong, and move them toward becoming potential customers. The target audience is RevOps who attended the Gong breakfast event in Stockholm, part of EMEA marketing initiatives.
#### Parameters sent to Gong via API when adding to flow with content override
- **Send Flow ID**. The flow you want to start
- **Send Contact ID**. The contact you want to add to the flow
- **Send Owner ID**. The user you want to be assigned to the flow instance
- Flow instance step content override:
- **Step number**
- **Subject**
- **Body HTML**
#### Updating part of the content without overriding all of it
You can update specific parts of your content without overwriting the entire flow. To do this, you can use field placeholders that have already been placed in your content. When you send new field placeholder values through the API, they will automatically replace the existing field placeholders in the flow.
These are the parameters that will be sent to Gong via API:
- **Send Flow ID**. The flow you want to start
- **Send Contact ID.** The contact you want to add to the flow
- **Send Owner ID**. The user you want to be assigned to the flow instance
- **Field placeholder Values**
- **Field placeholder key**
- **Field placeholder Value**
#### Updating the flow description
To do this, you can use field placeholders that have already been placed in your content. When you send new field placeholders values through the API, they will automatically replace the existing field placeholders in the flow.
These are the parameters that will be sent to Gong via API:
- **Send Flow ID**. The flow you want to start
- **Send Contact ID**. The contact you want to add to the flow
- **Send Owner ID**. The user you want to be assigned to the flow instance
- **Field placeholder values**
- **Field placeholder key**
- **FIeld placeholder Value**
- **Flow Instance Description.** A text paragraph
## Unassign flows by CRM Prospect ID (/v2/flows/prospects/unassign-flows-by-crm-id)
**post** /v2/flows/prospects/unassign-flows-by-crm-id
This endpoint lets you remove a specific prospect from the flows they’re assigned to. To remove the prospect from all flows they are assigned to, send the **crmProspectId** only.
To remove the prospect from a specific flow, get the flow ID from the **/v2/flows/prospects** endpoint and include the **crmProspectId** and **flowId** in the request.
The IDs of the flows the prospect was successfully removed from are returned in the response.
When accessed through a Bearer token authorization method, this endpoint requires the scope **api:flows:write**.
[See API docs](https://gong.app.gong.io/settings/api/documentation#post-/v2/flows/prospects/unassign-flows-by-crm-id)
## Unassign flows by Flow Instance ID (/v2/flows/prospects/unassign-flows-by-instance-id)
**post** /v2/flows/prospects/unassign-flows-by-instance-id
This endpoint lets you specify flow instances to remove prospects from. A flow instance is created when a prospect is added to a flow. Retrieve the flow instance ID from the **/v2/flows/prospects** endpoint.
The flow instance IDs the prospect was successfully removed from are returned in the response. If a prospect couldn’t be removed from a flow for any reason, the ID isn’t returned in the response, and the prospect is still assigned to the flow. You can remove prospects from up to 100 flows in a single request.
When accessed through a Bearer token authorization method, this endpoint requires the scope **api:flows:write**.
[See API docs](https://gong.app.gong.io/settings/api/documentation#post-/v2/flows/prospects/unassign-flows-by-instance-id)
A team member who manages and configures the Gong platform and handles CRM integrations, user provisioning, permissions, and system settings. [Find my Tech admin](/v1/docs/find-your-technical-or-business-admin).
A team member who manages the business entities in Gong, such as deal and forecast boards. [Find my Business admin](/v1/docs/find-your-technical-or-business-admin).
Gong’s AI-driven sales engagement solution that helps sales teams prioritize, personalize, and automate outreach activities to accelerate their pipelines. Access to features depends on your [company’s plan and your assigned seat](/v1/docs/plans-and-seats).