> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Gong: Get Flow Prospects Bulk Assignment

> Check the results of a bulk assignment of prospects to a Gong Engage flow. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Check the results of a bulk assignment of prospects to a Gong Engage flow.

> [!NOTE]
>
> Tool ID: `gong_get_flow_prospects_bulk_assignment`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'gong_get_flow_prospects_bulk_assignment',
  {
    "id": "id_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_get_flow_prospects_bulk_assignment --input '{
  "id": "id_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "requestId": "request_123",
    "id": "id_123",
    "status": "PENDING"
  }
}
```

Use `deepline describe gong_get_flow_prospects_bulk_assignment --json` for the latest machine-readable contract.

## Input reference

Use this endpoint to get the results of a bulk assignment of prospects to a flow. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:flows:read'.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | — |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Use this endpoint to get the results of a bulk assignment of prospects to a flow. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:flows:read'.",
    "properties": {
      "id": {
        "type": "string"
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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.id` | `string` | No | — | The ID of the bulk assignment. |
| `result.data.status` | `"PENDING" \| "IN_PROGRESS" \| "COMPLETED" \| "FAILED"` | No | — | The status of the bulk assignment. Allowed: `PENDING`, `IN_PROGRESS`, `COMPLETED`, `FAILED`. |
| `result.data.totalCount` | `integer` | No | — | The total count of prospects to be assigned. Format: `int32`. |
| `result.data.processedCount` | `integer` | No | — | The count of prospects that have been processed. Format: `int32`. |
| `result.data.successCount` | `integer` | No | — | The count of prospects that were successfully assigned. Format: `int32`. |
| `result.data.failedCount` | `integer` | No | — | The count of prospects that failed to be assigned. Format: `int32`. |
| `result.data.results` | `array` | No | — | The bulk assignment results. |
| `result.data.results[].prospect` | `object` | No | — | The prospect. |
| `result.data.results[].prospect.firstName` | `string` | No | — | The first name of the prospect. Required if the crmId is not provided. |
| `result.data.results[].prospect.lastName` | `string` | No | — | The last name of the prospect. Required if the CRM ID is not provided. |
| `result.data.results[].prospect.email` | `string` | No | — | The email of the prospect. |
| `result.data.results[].prospect.jobTitle` | `string` | No | — | The job title of the prospect. |
| `result.data.results[].prospect.linkedInUrl` | `string` | No | — | The LinkedIn URL of the prospect. |
| `result.data.results[].prospect.crmId` | `string` | No | — | The CRM ID of the prospect. |
| `result.data.results[].prospect.accountCrmId` | `string` | No | — | The CRM ID of the account the prospect belongs to. |
| `result.data.results[].prospect.companyName` | `string` | No | — | The name of the company the prospect belongs to. |
| `result.data.results[].status` | `"CRM_OPERATION_FAILED" \| "FLOW_ASSIGNMENT_FAILED" \| "ASSIGNED"` | No | — | The status of the flow assignment. Allowed: `CRM_OPERATION_FAILED`, `FLOW_ASSIGNMENT_FAILED`, `ASSIGNED`. |
| `result.data.results[].crmId` | `string` | No | — | The CRM ID of the prospect. |
| `result.data.results[].flowInstanceId` | `string` | No | — | The newly created flow instance ID. |
| `result.data.results[].errorCode` | `string` | No | — | Error code of a failed flow assignment. |
| `result.data.results[].errorMessage` | `string` | No | — | Error message of a failed flow assignment. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."
          },
          "id": {
            "type": "string",
            "description": "The ID of the bulk assignment."
          },
          "status": {
            "type": "string",
            "description": "The status of the bulk assignment.",
            "enum": [
              "PENDING",
              "IN_PROGRESS",
              "COMPLETED",
              "FAILED"
            ]
          },
          "totalCount": {
            "type": "integer",
            "description": "The total count of prospects to be assigned.",
            "format": "int32"
          },
          "processedCount": {
            "type": "integer",
            "description": "The count of prospects that have been processed.",
            "format": "int32"
          },
          "successCount": {
            "type": "integer",
            "description": "The count of prospects that were successfully assigned.",
            "format": "int32"
          },
          "failedCount": {
            "type": "integer",
            "description": "The count of prospects that failed to be assigned.",
            "format": "int32"
          },
          "results": {
            "type": "array",
            "description": "The bulk assignment results.",
            "items": {
              "type": "object",
              "description": "The bulk assignment results.",
              "properties": {
                "prospect": {
                  "type": "object",
                  "description": "The prospect.",
                  "properties": {
                    "firstName": {
                      "type": "string",
                      "description": "The first name of the prospect. Required if the crmId is not provided."
                    },
                    "lastName": {
                      "type": "string",
                      "description": "The last name of the prospect. Required if the CRM ID is not provided."
                    },
                    "email": {
                      "type": "string",
                      "description": "The email of the prospect."
                    },
                    "jobTitle": {
                      "type": "string",
                      "description": "The job title of the prospect."
                    },
                    "linkedInUrl": {
                      "type": "string",
                      "description": "The LinkedIn URL of the prospect."
                    },
                    "crmId": {
                      "type": "string",
                      "description": "The CRM ID of the prospect."
                    },
                    "accountCrmId": {
                      "type": "string",
                      "description": "The CRM ID of the account the prospect belongs to."
                    },
                    "companyName": {
                      "type": "string",
                      "description": "The name of the company the prospect belongs to."
                    }
                  },
                  "additionalProperties": false
                },
                "status": {
                  "type": "string",
                  "description": "The status of the flow assignment.",
                  "enum": [
                    "CRM_OPERATION_FAILED",
                    "FLOW_ASSIGNMENT_FAILED",
                    "ASSIGNED"
                  ]
                },
                "crmId": {
                  "type": "string",
                  "description": "The CRM ID of the prospect."
                },
                "flowInstanceId": {
                  "type": "string",
                  "description": "The newly created flow instance ID."
                },
                "errorCode": {
                  "type": "string",
                  "description": "Error code of a failed flow assignment."
                },
                "errorMessage": {
                  "type": "string",
                  "description": "Error message of a failed flow assignment."
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Gong provider guide](https://deepline.com/docs/providers/gong/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.