Pular para o conteúdo
ZaiaZaiaZaia

/api/v1/squads (POST)

POST
/api/v1/squads
curl --request POST \
  --url https://api.endless.zaia.app/api/v1/squads \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "mode": "hierarchical", "name": "example", "picture": "example" }'

Creates a new squad.

Request Bodyrequired

Seção intitulada “Request Bodyrequired”
Media typeapplication/json
object
description
required

The internal description of the squad.

string
nullable >= 3 characters <= 250 characters
mode
required

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

string
Allowed values: hierarchical flat
name
required

The display name of the squad.

string
>= 3 characters <= 50 characters
picture
required

The picture associated with the squad.

string
nullable

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

The squad was created.

Media typeapplication/json
object
createdAt
required
string format: date-time
id
required

A UUID v4 string that identifies an entity.

string format: uuid
isRemoved
required
boolean
referenceId
required

The ID of the original entity in production.

string format: uuid
nullable
updatedAt
required
string format: date-time
versionId
required

A UUID v4 string that identifies an entity.

string format: uuid
description
required

The internal description of the squad.

string
nullable >= 3 characters <= 250 characters
mode
required

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

string
Allowed values: hierarchical flat
name
required

The display name of the squad.

string
>= 3 characters <= 50 characters
picture
required

The picture associated with the squad.

string
nullable
superIdentityId
required

The super identity ID associated with the squad.

string format: uuid
workspaceId
required

The workspace ID that owns the squad.

string format: uuid
Example
{
  "mode": "hierarchical"
}

401

Seção intitulada “401”

Unauthorized.

Media typeapplication/json

The description of a known exception.

object
code

The error code.

string
cta

The error call-to-action.

object
type
required
string
Allowed values: support-contact
url
required
string format: uri
feedback
required

The error feedback.

object
enUs
string
esEs
string
ptBr
string
message
required

The error message.

string
name
required

The error name.

string
Example
{
  "cta": {
    "type": "support-contact"
  }
}

403

Seção intitulada “403”

Plan limit exceeded.

Media typeapplication/json

The description of a known exception.

object
code

The error code.

string
cta

The error call-to-action.

object
type
required
string
Allowed values: support-contact
url
required
string format: uri
feedback
required

The error feedback.

object
enUs
string
esEs
string
ptBr
string
message
required

The error message.

string
name
required

The error name.

string
Example
{
  "cta": {
    "type": "support-contact"
  }
}