Skip to main content
POST
/
api
/
v1
/
squads
Create a new squad
curl --request POST \
  --url https://prod.featherhq.com/api/v1/squads \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "entrypointAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>"
}
'
{
  "squad": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "entrypointAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "archived": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "entrypointAgent": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "agentType": "CALL"
    }
  }
}

Authorizations

X-API-Key
string
header
required

Body

application/json
name
string
required
Required string length: 1 - 100
entrypointAgentId
string<uuid>
required
description
string
Maximum string length: 500

Response

Squad created successfully

squad
object
required