> ## 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: Assign Prospects Cool Off Overrides

> Add CRM contacts or leads to a Gong Engage flow even if they are in a cool-off period. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Add CRM contacts or leads to a Gong Engage flow even if they are in a cool-off period.

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

## 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_assign_prospects_cool_off_overrides',
  {
    "crmProspectsIds": [
      "crm_prospects_123"
    ],
    "flowId": "flow_123",
    "flowInstanceOwnerEmail": "jane.doe@example.com"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_assign_prospects_cool_off_overrides --input '{
  "crmProspectsIds": [
    "crm_prospects_123"
  ],
  "flowId": "flow_123",
  "flowInstanceOwnerEmail": "jane.doe@example.com"
}' --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",
    "prospectsAssigned": [
      {
        "flowId": "flow_123",
        "flowName": "Example",
        "crmProspectId": "crm_prospect_123"
      }
    ],
    "prospectsNotAssigned": [
      {
        "flowId": "flow_123",
        "crmProspectId": "crm_prospect_123",
        "errorCode": "InvalidArgument"
      }
    ]
  }
}
```

Use `deepline describe gong_assign_prospects_cool_off_overrides --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). |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Flow assignment parameters.",
    "properties": {
      "crmProspectsIds": {
        "type": "array",
        "description": "The CRM IDs of the contact or lead that should be assigned to a flow.",
        "uniqueItems": true,
        "items": {
          "type": "string",
          "description": "The CRM IDs of the contact or lead that should be assigned to a flow."
        }
      },
      "flowId": {
        "type": "string",
        "description": "The Engage Flow ID to assign the contacts to."
      },
      "flowInstanceOwnerEmail": {
        "type": "string",
        "description": "The email of the Gong user who owns the flow to-dos."
      },
      "overrides": {
        "type": "object",
        "description": "Defines the new data for specific steps and variables in the flow (in Beta Phase).",
        "properties": {
          "steps": {
            "type": "array",
            "description": "The steps in the flow to override. The step subject and body can be updated.",
            "items": {
              "type": "object",
              "description": "The steps in the flow to override. The step subject and body can be updated.",
              "properties": {
                "number": {
                  "type": "integer",
                  "description": "The number of the step to update in the flow. The first step in the flow is 1.",
                  "format": "int32"
                },
                "subject": {
                  "type": "string",
                  "description": "The new subject for the step."
                },
                "body": {
                  "type": "string",
                  "description": "The new body for the step."
                }
              },
              "required": [
                "number"
              ],
              "additionalProperties": false
            }
          },
          "flowInstanceVariables": {
            "type": "array",
            "description": "The flow variables to update. Changes to these variables are applied to the entire flow.",
            "items": {
              "type": "object",
              "description": "The flow variables to update. Changes to these variables are applied to the entire flow.",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of the variable you want to update."
                },
                "value": {
                  "type": "string",
                  "description": "The new value for the variable."
                }
              },
              "required": [
                "name",
                "value"
              ],
              "additionalProperties": false
            }
          },
          "coolOffOverride": {
            "type": "boolean",
            "description": "To assign prospects to the flow regardless of the cool off status."
          }
        },
        "additionalProperties": false
      },
      "flowInstanceDescription": {
        "type": "string",
        "description": "The description for the flow instance (in Beta Phase)."
      }
    },
    "required": [
      "crmProspectsIds",
      "flowId",
      "flowInstanceOwnerEmail"
    ],
    "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.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). |

<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."
          },
          "prospectsAssigned": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "flowId": {
                  "type": "string",
                  "description": "The Gong Engage Flow ID the prospect was assigned to."
                },
                "flowName": {
                  "type": "string",
                  "description": "The Gong Engage Flow name the prospect was assigned to."
                },
                "crmProspectId": {
                  "type": "string",
                  "description": "The CRM ID of the prospect that was assigned to a Gong Engage flow."
                },
                "flowInstanceId": {
                  "type": "string",
                  "description": "The newly created flow instance id."
                },
                "flowInstanceOwnerEmail": {
                  "type": "string",
                  "description": "The email address of the Gong user who owns the flow instance tasks."
                },
                "flowInstanceOwnerFullName": {
                  "type": "string",
                  "description": "The full name of the Gong user who owns the flow instance tasks."
                },
                "flowInstanceCreateDate": {
                  "type": "string",
                  "description": "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."
                },
                "flowInstanceStatus": {
                  "type": "string",
                  "description": "The status of the flow instance.",
                  "enum": [
                    "Pending",
                    "Running",
                    "Paused",
                    "FinishedNoReply",
                    "FinishedResponse",
                    "Finished"
                  ]
                },
                "workspaceId": {
                  "type": "string",
                  "description": "The workspace ID this flow belongs to."
                },
                "exclusive": {
                  "type": "boolean",
                  "description": "Indicates whether a prospect in this flow can be added to other flows"
                }
              },
              "additionalProperties": false
            }
          },
          "prospectsNotAssigned": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "flowId": {
                  "type": "string",
                  "description": "The flow ID to which the assignment failed"
                },
                "crmProspectId": {
                  "type": "string",
                  "description": "The CRM ID of the prospect that failed to get assigned to a Gong Engage flow."
                },
                "errorCode": {
                  "type": "string",
                  "description": "The code of the assignment error",
                  "enum": [
                    "InvalidArgument",
                    "InvalidState",
                    "UnexpectedError"
                  ]
                },
                "errorMessage": {
                  "type": "string",
                  "description": "A message describing the assignment error"
                }
              },
              "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.