> ## Documentation Index > Fetch the complete documentation index at: https://docs.getmodus.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a workflow interface > Patches the `name` and/or `config` of an interface (for example Slack `availableChannelIds`). At least one field is required. Pass `?updateMask=` to restrict which fields are written. **Requires:** `workflows:write` ## OpenAPI ````yaml https://api.getmodus.com/openapi.json patch /api/v1/workflows/{id}/interfaces/{interfaceId} openapi: 3.0.3 info: title: Modus Public API version: 1.0.0 servers: [] security: - bearerAuth: [] tags: - name: Scopes description: Create, configure, deploy, and manage scopes. - name: Scopes · Conversations description: Read scope conversation threads. - name: Scopes · Supervision description: Scope supervision sub-resource. - name: Scopes · Memories description: Long-term memory stored per scope. - name: Scopes · Chat description: Chat with a published scope. - name: Scopes · Context description: Compose a scope’s context without an LLM call. - name: Modus · Chat description: Chat with Modus — your org-wide assistant. - name: Modus · Conversations description: Read Modus and cross-scope conversation threads. - name: Modus · Context description: Compose full-environment context without an LLM call. - name: Workflows description: Create, configure, deploy, and manage workflows. - name: Workflows · Runs description: Inspect workflow run history. - name: Workflows · Interfaces description: Slack / MCP / Teams interface management. - name: Connections description: Read connected integrations. - name: Tools description: Catalog of tools/integrations a scope can select in its toolset. - name: Suggestions description: Approved suggested questions and first-party suggestion usage events. - name: Context description: Create and manage organization context items. - name: Usage description: Organization LLM usage reporting. - name: Users description: Organization and membership management. - name: Runs · Streaming description: 'Run lifecycle: stream, poll, resume, interrupt, and cancel executions.' - name: Scopes · Runs description: Run a published or draft scope. - name: Modus · Runs description: Run the Modus home agent. paths: /api/v1/workflows/{id}/interfaces/{interfaceId}: patch: tags: - Workflows · Interfaces summary: Update a workflow interface description: >- Patches the `name` and/or `config` of an interface (for example Slack `availableChannelIds`). At least one field is required. Pass `?updateMask=` to restrict which fields are written. **Requires:** `workflows:write` operationId: WorkflowInterfacesController_update parameters: - name: id required: true in: path description: Numeric workflow id. schema: example: 42 type: number - name: interfaceId required: true in: path description: Interface row id (UUID). schema: example: 00000000-0000-4000-a000-000000000abc type: string - name: updateMask required: false in: query description: >- Comma-separated list of fields to update. Omit to update all provided fields. schema: example: name type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAgentInterfaceDto' examples: rename: value: name: Internal MCP v2 restrictChannels: value: config: availableChannelIds: - C0ALH2JTRR9 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AgentInterfaceDto' '400': description: >- Malformed request — invalid query parameters or request body (`code: BAD_REQUEST`). content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' example: error: code: BAD_REQUEST status: INVALID_ARGUMENT message: Invalid value for query parameter `pageSize`. requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS '401': description: 'Missing, invalid, or expired access token (`code: UNAUTHORIZED`).' content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' example: error: code: UNAUTHORIZED status: UNAUTHENTICATED message: Missing or invalid access token. requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS '403': description: >- Authenticated, but the token lacks a required scope (`code: FORBIDDEN`). The missing scopes are listed in `info`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' example: error: code: FORBIDDEN status: PERMISSION_DENIED message: Missing required scope(s) for this operation. requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS info: missing: - '404': description: >- The resource does not exist, or you do not have access to it (`code: NOT_FOUND`). content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' example: error: code: NOT_FOUND status: NOT_FOUND message: Resource not found. requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS '409': description: >- The request conflicts with the current state of the resource, e.g. a duplicate (`code: CONFLICT`). content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' example: error: code: CONFLICT status: ALREADY_EXISTS message: A resource with that identifier already exists. requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS '422': description: >- The request was well-formed but failed a business rule (`code: VALIDATION`). content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' example: error: code: VALIDATION status: INVALID_ARGUMENT message: Updates that would revoke your own access are not allowed. requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS '500': description: 'An unexpected server error occurred (`code: INTERNAL_ERROR`).' content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' example: error: code: INTERNAL_ERROR status: INTERNAL message: An unexpected error occurred. requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS security: - bearerAuth: [] servers: - url: https://api.getmodus.com components: schemas: UpdateAgentInterfaceDto: type: object properties: name: type: string description: New display name. example: Internal MCP v2 minLength: 1 maxLength: 200 config: type: object description: >- New config payload (interface-type-specific). Free-form JSONB. Replaces the prior config. additionalProperties: true example: {} AgentInterfaceDto: type: object properties: id: type: string description: Interface row id (UUID). example: 00000000-0000-4000-a000-000000000300 agentId: type: number description: Parent workflow id. example: 42 type: description: >- Interface type. `slack` and `teams` deliver chat triggers; `mcp` exposes the workflow as an MCP server. example: mcp allOf: - $ref: '#/components/schemas/AgentInterfaceType' name: type: string description: Display name for the interface (shown in the SPA). example: Internal MCP config: type: object description: >- Interface-type-specific configuration (e.g. webhook url, MCP token references). Free-form JSONB. additionalProperties: true example: {} createdAt: type: string description: Creation timestamp. example: '2026-05-01T10:00:00.000Z' updatedAt: type: string description: Most recent update timestamp. example: '2026-05-11T10:00:00.000Z' required: - id - agentId - type - name - config - createdAt - updatedAt ErrorResponseDto: type: object properties: error: $ref: '#/components/schemas/ErrorEnvelopeDto' required: - error AgentInterfaceType: type: string enum: - slack - mcp - teams description: >- Interface type. `slack` and `teams` deliver chat triggers; `mcp` exposes the workflow as an MCP server. ErrorEnvelopeDto: type: object properties: code: description: Modus-specific machine code. allOf: - $ref: '#/components/schemas/ApiErrorCode' status: description: Canonical status string for the error. allOf: - $ref: '#/components/schemas/ApiErrorStatus' message: type: string example: Skill was not found or you lack permission. requestId: type: string example: req_01HQ7K8ABCDEFGHIJKLMNOPQRS info: type: object description: >- Optional domain-specific context. Shape varies per endpoint — see the operation's error response examples. additionalProperties: true example: skillId: sk_abc123 required: - code - status - message - requestId ApiErrorCode: type: string enum: - VALIDATION - BAD_REQUEST - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - RATE_LIMITED - INTERNAL_ERROR description: Modus-specific machine code. ApiErrorStatus: type: string enum: - INVALID_ARGUMENT - UNAUTHENTICATED - PERMISSION_DENIED - NOT_FOUND - ALREADY_EXISTS - RESOURCE_EXHAUSTED - INTERNAL description: Canonical status string for the error. securitySchemes: bearerAuth: scheme: bearer bearerFormat: Modus PAT (modus___) or OAuth 2.1 access token type: http description: >- A Modus personal access token (`modus___`) or an OAuth 2.1 access token, sent as `Authorization: Bearer `. ````