> ## 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.

# Salesforge: Patch Multichannel Workspaces Workspaceid Sequences Sequenceid Status

> Update the status of a Salesforge multichannel sequence, for example to pause or resume it. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Update the status of a Salesforge multichannel sequence, for example to pause or resume it.

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

## 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(
  'salesforge_patch_multichannel_workspaces_workspaceid_sequences_sequenceid_status',
  {
    "workspaceID": "workspace_123",
    "sequenceID": 123,
    "status": "active"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute salesforge_patch_multichannel_workspaces_workspaceid_sequences_sequenceid_status --input '{
  "workspaceID": "workspace_123",
  "sequenceID": 123,
  "status": "active"
}' --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": {
    "analytics": {
      "actionCounts": {},
      "computedAt": "2026-01-15T12:00:00Z",
      "connectionRequests": {
        "accepted": 123,
        "conversion": 123,
        "sent": 123
      }
    },
    "companyOutreachLimitCount": 123,
    "companyOutreachLimitEnabled": true
  }
}
```

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

## Input reference

Update sequence status

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.workspaceID` | `string` | Yes | — | Workspace ID |
| `payload.sequenceID` | `integer` | Yes | — | Sequence ID |
| `payload.status` | `"active" \| "paused"` | Yes | — | Allowed: `active`, `paused`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Update sequence status",
    "properties": {
      "workspaceID": {
        "type": "string",
        "description": "Workspace ID"
      },
      "sequenceID": {
        "type": "integer",
        "description": "Sequence ID"
      },
      "status": {
        "type": "string",
        "enum": [
          "active",
          "paused"
        ]
      }
    },
    "required": [
      "workspaceID",
      "sequenceID",
      "status"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.analytics` | `object` | No | — | — |
| `result.data.analytics.actionCounts` | `record` | No | — | — |
| `result.data.analytics.computedAt` | `string` | No | — | — |
| `result.data.analytics.connectionRequests` | `object` | No | — | — |
| `result.data.analytics.connectionRequests.accepted` | `integer` | No | — | — |
| `result.data.analytics.connectionRequests.conversion` | `number` | No | — | — |
| `result.data.analytics.connectionRequests.sent` | `integer` | No | — | — |
| `result.data.analytics.contacts` | `object` | No | — | — |
| `result.data.analytics.contacts.completed` | `integer` | No | — | — |
| `result.data.analytics.contacts.failed` | `integer` | No | — | — |
| `result.data.analytics.contacts.inProgress` | `integer` | No | — | — |
| `result.data.analytics.contacts.total` | `integer` | No | — | — |
| `result.data.analytics.emailGoalsAchievedCount` | `integer` | No | — | — |
| `result.data.analytics.emailGoalsValue` | `number` | No | — | — |
| `result.data.analytics.emails` | `object` | No | — | — |
| `result.data.analytics.emails.bounced` | `integer` | No | — | — |
| `result.data.analytics.emails.bouncedPercent` | `number` | No | — | — |
| `result.data.analytics.emails.clicked` | `integer` | No | — | — |
| `result.data.analytics.emails.clickedPercent` | `number` | No | — | — |
| `result.data.analytics.emails.contacted` | `integer` | No | — | — |
| `result.data.analytics.emails.conversion` | `number` | No | — | — |
| `result.data.analytics.emails.opened` | `integer` | No | — | — |
| `result.data.analytics.emails.openedPercent` | `number` | No | — | — |
| `result.data.analytics.emails.optOuted` | `integer` | No | — | — |
| `result.data.analytics.emails.optOutedPercent` | `number` | No | — | — |
| `result.data.analytics.emails.replied` | `integer` | No | — | — |
| `result.data.analytics.emails.repliedPercent` | `number` | No | — | — |
| `result.data.analytics.emails.sent` | `integer` | No | — | — |
| `result.data.analytics.goalsAchievedCount` | `integer` | No | — | — |
| `result.data.analytics.linkedinGoalsAchievedCount` | `integer` | No | — | — |
| `result.data.analytics.linkedinGoalsValue` | `number` | No | — | — |
| `result.data.analytics.linkedinMessages` | `object` | No | — | — |
| `result.data.analytics.linkedinMessages.conversion` | `number` | No | — | — |
| `result.data.analytics.linkedinMessages.replied` | `integer` | No | — | — |
| `result.data.analytics.linkedinMessages.sent` | `integer` | No | — | — |
| `result.data.analytics.opportunitiesCount` | `integer` | No | — | — |
| `result.data.analytics.positiveReplies` | `object` | No | — | — |
| `result.data.analytics.positiveReplies.conversion` | `number` | No | — | — |
| `result.data.analytics.positiveReplies.email` | `integer` | No | — | — |
| `result.data.analytics.positiveReplies.linkedin` | `integer` | No | — | — |
| `result.data.analytics.progressPercentage` | `number` | No | — | — |
| `result.data.analytics.totalEmailActionsCount` | `integer` | No | — | — |
| `result.data.analytics.totalGoalsValue` | `number` | No | — | — |
| `result.data.analytics.totalLinkedinActionsCount` | `integer` | No | — | — |
| `result.data.analytics.totalOpportunitiesValue` | `number` | No | — | — |
| `result.data.analytics.trackOpportunitiesEnabled` | `boolean` | No | — | — |
| `result.data.companyOutreachLimitCount` | `integer` | No | — | — |
| `result.data.companyOutreachLimitEnabled` | `boolean` | No | — | — |
| `result.data.createdAt` | `string` | No | — | — |

The table shows the first 50 fields. Expand the raw schema below for every field.

<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": {
          "analytics": {
            "type": "object",
            "properties": {
              "actionCounts": {
                "type": "object",
                "additionalProperties": {
                  "type": "integer"
                }
              },
              "computedAt": {
                "type": "string"
              },
              "connectionRequests": {
                "type": "object",
                "properties": {
                  "accepted": {
                    "type": "integer"
                  },
                  "conversion": {
                    "type": "number"
                  },
                  "sent": {
                    "type": "integer"
                  }
                },
                "additionalProperties": false
              },
              "contacts": {
                "type": "object",
                "properties": {
                  "completed": {
                    "type": "integer"
                  },
                  "failed": {
                    "type": "integer"
                  },
                  "inProgress": {
                    "type": "integer"
                  },
                  "total": {
                    "type": "integer"
                  }
                },
                "additionalProperties": false
              },
              "emailGoalsAchievedCount": {
                "type": "integer"
              },
              "emailGoalsValue": {
                "type": "number"
              },
              "emails": {
                "type": "object",
                "properties": {
                  "bounced": {
                    "type": "integer"
                  },
                  "bouncedPercent": {
                    "type": "number"
                  },
                  "clicked": {
                    "type": "integer"
                  },
                  "clickedPercent": {
                    "type": "number"
                  },
                  "contacted": {
                    "type": "integer"
                  },
                  "conversion": {
                    "type": "number"
                  },
                  "opened": {
                    "type": "integer"
                  },
                  "openedPercent": {
                    "type": "number"
                  },
                  "optOuted": {
                    "type": "integer"
                  },
                  "optOutedPercent": {
                    "type": "number"
                  },
                  "replied": {
                    "type": "integer"
                  },
                  "repliedPercent": {
                    "type": "number"
                  },
                  "sent": {
                    "type": "integer"
                  }
                },
                "additionalProperties": false
              },
              "goalsAchievedCount": {
                "type": "integer"
              },
              "linkedinGoalsAchievedCount": {
                "type": "integer"
              },
              "linkedinGoalsValue": {
                "type": "number"
              },
              "linkedinMessages": {
                "type": "object",
                "properties": {
                  "conversion": {
                    "type": "number"
                  },
                  "replied": {
                    "type": "integer"
                  },
                  "sent": {
                    "type": "integer"
                  }
                },
                "additionalProperties": false
              },
              "opportunitiesCount": {
                "type": "integer"
              },
              "positiveReplies": {
                "type": "object",
                "properties": {
                  "conversion": {
                    "type": "number"
                  },
                  "email": {
                    "type": "integer"
                  },
                  "linkedin": {
                    "type": "integer"
                  }
                },
                "additionalProperties": false
              },
              "progressPercentage": {
                "type": "number"
              },
              "totalEmailActionsCount": {
                "type": "integer"
              },
              "totalGoalsValue": {
                "type": "number"
              },
              "totalLinkedinActionsCount": {
                "type": "integer"
              },
              "totalOpportunitiesValue": {
                "type": "number"
              },
              "trackOpportunitiesEnabled": {
                "type": "boolean"
              }
            },
            "additionalProperties": false
          },
          "companyOutreachLimitCount": {
            "type": "integer"
          },
          "companyOutreachLimitEnabled": {
            "type": "boolean"
          },
          "createdAt": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "id": {
            "type": "integer"
          },
          "launchedAt": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "opportunitiesValue": {
            "type": "number"
          },
          "schedule": {
            "type": "object",
            "properties": {
              "friday": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "from": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  },
                  "to": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  }
                },
                "additionalProperties": false
              },
              "monday": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "from": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  },
                  "to": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  }
                },
                "additionalProperties": false
              },
              "saturday": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "from": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  },
                  "to": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  }
                },
                "additionalProperties": false
              },
              "sunday": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "from": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  },
                  "to": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  }
                },
                "additionalProperties": false
              },
              "thursday": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "from": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  },
                  "to": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  }
                },
                "additionalProperties": false
              },
              "tuesday": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "from": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  },
                  "to": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  }
                },
                "additionalProperties": false
              },
              "wednesday": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "from": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  },
                  "to": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 23
                  }
                },
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          },
          "senderProfiles": {
            "type": "array",
            "uniqueItems": false,
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                },
                "profilePictureUrl": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "sequentialCompanySendingEnabled": {
            "type": "boolean"
          },
          "settings": {
            "type": "object",
            "properties": {
              "bcc": {
                "type": "string"
              },
              "cc": {
                "type": "string"
              },
              "ccAndBccEnabled": {
                "type": "boolean"
              },
              "clickTrackingEnabled": {
                "type": "boolean"
              },
              "companyOutreachLimitCount": {
                "type": "integer"
              },
              "companyOutreachLimitEnabled": {
                "type": "boolean"
              },
              "localizedOptOutEnabled": {
                "type": "boolean"
              },
              "openTrackingEnabled": {
                "type": "boolean"
              },
              "opportunitiesValue": {
                "type": "number"
              },
              "optOutLinkEnabled": {
                "type": "boolean"
              },
              "optOutLinkText": {
                "type": "string"
              },
              "optOutText": {
                "type": "string"
              },
              "optOutTextEnabled": {
                "type": "boolean"
              },
              "pauseOnClick": {
                "type": "boolean"
              },
              "pauseOnOpen": {
                "type": "boolean"
              },
              "plainTextEmailsEnabled": {
                "type": "boolean"
              },
              "sequentialCompanySendingEnabled": {
                "type": "boolean"
              },
              "taskPriorityPolicy": {
                "type": "string"
              },
              "trackOpportunitiesEnabled": {
                "type": "boolean"
              }
            },
            "additionalProperties": false
          },
          "status": {
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "trackOpportunitiesEnabled": {
            "type": "boolean"
          },
          "updatedAt": {
            "type": "string"
          },
          "workspaceId": {
            "type": "string"
          }
        },
        "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

* [Salesforge provider guide](https://deepline.com/docs/providers/salesforge/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.