SKskyfire

Update Organization User Agent

Changed on

As an Organization Admin, rename, deactivate, or reactivate one of your organization users' ungrouped agents.

patch/api/v1/organizations/users/{userId}/agents/{agentId}

Request

  • Base URL
    https://api.skyfire.xyz
  • URL
    https://api.skyfire.xyz/api/v1/organizations/users/{userId}/agents/{agentId}
  • Auth
    API key in header skyfire-api-key

Path parameters

userIdstring uuid required

Unique identifier of the organization user who owns the agent. e.g. "906fc259-ef0a-4736-bdcd-c1d5a78db483"

agentIdstring uuid required

Unique identifier of the agent. e.g. "5d084831-4a11-4970-bf62-bb6fc0b9f3a2"

Request body

displayNamestring

New display name. Printable ASCII with at least one non-space character, 1 to 100 characters. Must be free among the user's active agents and not match an active agent group in your organization.

activeboolean

false deactivates the agent: its API keys stop authenticating and its cards are removed. true reactivates it; cards are not restored.

Response

No Content. The agent was updated.

Changes