Skip to main content
PUT
/
squads
/
:id
Update Squad
curl --request PUT \
  --url https://api.example.com/squads/:id

Documentation Index

Fetch the complete documentation index at: https://docs.orkeia.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

PUT https://gateway.orkeia.ai/squads/{id} Authentication
Requires header authorization: <your_token>.

​
Path Parameters

NameTypeRequiredDescriptionExample
idstringYesUnique identifier of the squad.SQUAD_1234

​
Request Body (JSON)

The service expects a wrapper with the property squad. 
{
  "squad": {
    "name": "Equipe Alpha - Atualizada",
    "description": "Nova descrição",
    "enabled": true
  }
}

​
Example (cURL)

curl -X PUT "https://gateway.orkeia.ai/squads/SQUAD_1234" \
  -H "authorization:  <your_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "squad": {
      "name": "Equipe Alpha - Atualizada",
      "description": "Nova descrição",
      "enabled": true
    }
  }'

​
Responses

​
Response - Success

response
{
  "status": "OK",
  "data": {
    "id": "SQUAD_1234",
    "name": "Equipe Alpha - Atualizada",
    "description": "Nova descrição",
    "enabled": true,
    "createdAt": "2024-07-15T14:25:18.000Z"
  }
}

​
500 — Server Error

{
  "status": "ERROR",
  "code": "server/error",
  "data": null
}

​
400 — Client Error

{
  "status": "ERROR",
  "code": "client/error",
  "data": null
}

​
Fields

FieldTypeDescription
idstringID of the squad
namestringName
descriptionstringDescription
enabledbooleanWhether it is enabled
createdAtstringCreation date (ISO 8601)