Skip to navigation
API ReferenceConnectionsSlack

Update Slack Installation

Update Slack installation defaults or lifecycle status.

Both fields are optional and only the ones present in the request are written. default_task_agent_id must name a TaskAgent in this project, or the request answers 400. Setting status to anything other than active also marks the linked integration’s credential revoked and puts it into reauth_required, so reconnecting the workspace means running the OAuth flow again.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

OR
AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

org_idstringRequiredformat: "uuid"
The organization ID
project_idstringRequiredformat: "uuid"
The project ID
installation_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
statusenum or nullOptional
Lifecycle status for the Slack installation.
Allowed values:
default_task_agent_idstring or nullOptionalformat: "uuid"
Default TaskAgent used when a channel has no explicit mapping.

Response

Slack installation updated successfully
idstringformat: "uuid"
Slack installation ID.
project_idstringformat: "uuid"
Project that owns the Slack installation.
team_idstring
Slack workspace team ID.
bot_user_idstring
Slack bot user ID for the installed app.
installed_by_user_idstringformat: "uuid"
User who completed the Slack installation flow.
statusenum
Lifecycle status for the Slack installation.
Allowed values:
createdstring
When the installation was created.
modifiedstring
When the installation was last updated.
team_namestring or nullOptional

Human-readable Slack workspace name.

default_task_agent_idstring or nullOptionalformat: "uuid"
Default TaskAgent used when a channel has no explicit mapping.

Errors

400
Bad Request Error
403
Forbidden Error
422
Unprocessable Entity Error