Gong: Assign Prospects

Assign prospects (contacts or leads) to an Engage flow (/v2/flows/prospects/assign).

Tool ID: gong_assign_prospects

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'gong_assign_prospects',
  {
    "crmProspectsIds": [
      "crm_prospects_123"
    ],
    "flowId": "flow_123",
    "flowInstanceOwnerEmail": "jane.doe@example.com"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute gong_assign_prospects --input '{
  "crmProspectsIds": [
    "crm_prospects_123"
  ],
  "flowId": "flow_123",
  "flowInstanceOwnerEmail": "jane.doe@example.com"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "requestId": "request_123",
    "prospectsAssigned": [
      {
        "flowId": "flow_123",
        "flowName": "Example",
        "crmProspectId": "crm_prospect_123"
      }
    ],
    "prospectsNotAssigned": [
      {
        "flowId": "flow_123",
        "crmProspectId": "crm_prospect_123",
        "errorCode": "InvalidArgument"
      }
    ]
  }
}

Use deepline tools get gong_assign_prospects --json for the latest machine-readable contract.

Input reference

Flow assignment parameters.

Name	Type	Required	Default	Details
`payload.crmProspectsIds`	`array`	Yes	—	The CRM IDs of the contact or lead that should be assigned to a flow. Items must be unique.
`payload.flowId`	`string`	Yes	—	The Engage Flow ID to assign the contacts to.
`payload.flowInstanceOwnerEmail`	`string`	Yes	—	The email of the Gong user who owns the flow to-dos.
`payload.overrides`	`object`	No	—	Defines the new data for specific steps and variables in the flow (in Beta Phase).
`payload.flowInstanceDescription`	`string`	No	—	The description for the flow instance (in Beta Phase).

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.requestId`	`string`	No	—	A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
`result.data.prospectsAssigned`	`array`	No	—	—
`result.data.prospectsAssigned[].flowId`	`string`	No	—	The Gong Engage Flow ID the prospect was assigned to.
`result.data.prospectsAssigned[].flowName`	`string`	No	—	The Gong Engage Flow name the prospect was assigned to.
`result.data.prospectsAssigned[].crmProspectId`	`string`	No	—	The CRM ID of the prospect that was assigned to a Gong Engage flow.
`result.data.prospectsAssigned[].flowInstanceId`	`string`	No	—	The newly created flow instance id.
`result.data.prospectsAssigned[].flowInstanceOwnerEmail`	`string`	No	—	The email address of the Gong user who owns the flow instance tasks.
`result.data.prospectsAssigned[].flowInstanceOwnerFullName`	`string`	No	—	The full name of the Gong user who owns the flow instance tasks.
`result.data.prospectsAssigned[].flowInstanceCreateDate`	`string`	No	—	The creation date of the flow instance in the ISO-8601 format, for example: ‘2024-01-17T16:20:05-03:00’ or ‘2016-02-16T03:57:04.834+05:30’ or ‘2020-11-20T21:30:07.233692Z’, where Z stands for UTC.
`result.data.prospectsAssigned[].flowInstanceStatus`	`"Pending" \| "Running" \| "Paused" \| "FinishedNoReply" \| "FinishedResponse" \| "Finished"`	No	—	The status of the flow instance. Allowed: `Pending`, `Running`, `Paused`, `FinishedNoReply`, `FinishedResponse`, `Finished`.
`result.data.prospectsAssigned[].workspaceId`	`string`	No	—	The workspace ID this flow belongs to.
`result.data.prospectsAssigned[].exclusive`	`boolean`	No	—	Indicates whether a prospect in this flow can be added to other flows
`result.data.prospectsNotAssigned`	`array`	No	—	—
`result.data.prospectsNotAssigned[].flowId`	`string`	No	—	The flow ID to which the assignment failed
`result.data.prospectsNotAssigned[].crmProspectId`	`string`	No	—	The CRM ID of the prospect that failed to get assigned to a Gong Engage flow.
`result.data.prospectsNotAssigned[].errorCode`	`"InvalidArgument" \| "InvalidState" \| "UnexpectedError"`	No	—	The code of the assignment error Allowed: `InvalidArgument`, `InvalidState`, `UnexpectedError`.
`result.data.prospectsNotAssigned[].errorMessage`	`string`	No	—	A message describing the assignment error
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Gong: Assign Prospects

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation