API ReferenceConsumer

Upsert one consumer tool permission for a connected accountv3.1

Markdown
PATCH
/api/v3.1/consumer/connected_accounts/{nanoid}/permissions/tools/{tool_slug}

Upserts a single durable Enhanced Control permission row for a connected account/tool pair.

Authorization

x-api-key<token>

Project API key authentication

In: header

Path Parameters

nanoidstringRequired

Connected account nano ID.

Format: connectedAccountId
tool_slugstringRequired

Tool slug to update.

Request Body

application/json

toolkit_slugstringRequired

Toolkit slug that owns this tool permission. Use this to group and query connected-account permissions by app/toolkit, for example gmail or slack.

risk_groupenumRequired
Possible values:
readwritedestructive
stateenumRequired
Possible values:
always_allowalways_denyask_onceask_always
sourceenum
Default: "settings"
Possible values:
initial_connectsettingselicitationmigration
permission_config_versionstring

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://backend.composio.dev/api/v3.1/consumer/connected_accounts/ca_1a2b3c4d5e6f/permissions/tools/GMAIL_SEND_EMAIL" \  -H "Content-Type: application/json" \  -d '{    "toolkit_slug": "string",    "risk_group": "read",    "state": "always_allow"  }'
{
  "permission": {
    "id": "string",
    "connected_account_id": "string",
    "tool_slug": "string",
    "toolkit_slug": "string",
    "risk_group": "read",
    "state": "always_allow",
    "source": "initial_connect",
    "permission_config_version": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}