Gby Gong
Add prospects to an Engage flow
Assigns up to 100 CRM contacts or leads to a Gong Engage flow, starting its email and call to-dos for them.
Description
Pass the prospects' CRM IDs in `crmProspectsIds`, the `flowId` (list flows with `GET /v2/flows`), and `flowInstanceOwnerEmail`, the Gong user who owns the flow's to-dos. `overrides` can replace a step's subject, body or placeholder values for this assignment. Needs Gong Engage, and OAuth apps need the `api:flows:write` scope. Assigning starts real outreach: confirm the flow and the prospects first.
assign-prospects-to-flow.md
Add prospects to an Engage flow
Assigns up to 100 CRM contacts or leads to a Gong Engage flow, starting its email and call to-dos for them.
Pass the prospects' CRM IDs in crmProspectsIds, the flowId (list flows
with GET /v2/flows), and flowInstanceOwnerEmail, the Gong user who owns
the flow's to-dos. overrides can replace a step's subject, body or
placeholder values for this assignment. Needs Gong Engage, and OAuth apps
need the api:flows:write scope. Assigning starts real outreach: confirm the
flow and the prospects first.
Set up
Use the first option your agent supports.
API (official)
- Base URL: https://{company}.api.gong.io
- Endpoint:
POST /v2/flows/prospects/assign - Auth: send the header
Authorization: Basic $GONG_API_KEY - Get a key: https://app.gong.io/company/api
- Docs: https://help.gong.io/apidocs/introduction-2
Before doing anything else, make one read-only call to confirm access.
Rules
- Ask the user before anything that sends messages, costs money, or changes data.
- Never print API keys.
Built from these files in the repository
The layout and the rules come from lib/catalog/render-markdown.ts, the set-up wording from lib/catalog/render-access.ts.
Ways in
| Route | Source | Call | Required | Docs |
|---|---|---|---|---|
| Official | POST /v2/flows/prospects/assign | API key in $GONG_API_KEY | Docs |