Assign Agent

Assigns an agent to the workspace. Propagates permissions to all agent campaigns, chats, and prospects. Agency plan required.

POST /workspaces/{id}/agents/{agentId}

Assign Agent

cURL

curl --request POST \
  --url https://api.kakiyo.com/v1/workspaces/{id}/agents/{agentId} \
  --header 'Authorization: Bearer <token>'

200

{
  "agentId": "agent_abc123",
  "workspaceId": "workspace_xyz789",
  "propagated": {
    "campaigns": 5,
    "chats": 150,
    "prospects": 150
  }
}

Agency Plan Required - This endpoint is only available for teams on the Agency plan.

Endpoint

POST https://api.kakiyo.com/v1/workspaces/:workspaceId/agents/:agentId

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	The workspace ID
agentId	string	Yes	The agent ID to assign

Response

{
  "agentId": "69724b7100331796aae2",
  "workspaceId": "69724d900007cfde1d88",
  "propagated": {
    "campaigns": 5,
    "chats": 150,
    "prospects": 150
  }
}

Example Request

curl -X POST "https://api.kakiyo.com/v1/workspaces/69724d900007cfde1d88/agents/69724b7100331796aae2" \
  -H "Authorization: Bearer YOUR_API_KEY"

When an agent is assigned, client permissions are automatically propagated to all associated campaigns, chats, and prospects.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Workspace ID

agentId · string · required

Agent ID to assign

Response

200

application/json

Agent assigned successfully

agentId · string

Example:

"agent_abc123"

workspaceId · string

Example:

"workspace_xyz789"

propagated · object

Show child attributes