Squads

Update Squad

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Path parameters

idstringRequired

Request

This endpoint expects an object.
memberslist of objectsRequired
This is the list of assistants that make up the squad. The call will start with the first assistant in the list.
namestringOptional
This is the name of the squad.
membersOverridesobjectOptional

This can be used to override all the assistants’ settings and provide values for their template variables.

Both membersOverrides and members[n].assistantOverrides can be used together. First, members[n].assistantOverrides is applied. Then, membersOverrides is applied as a global override.

Response

memberslist of objects
This is the list of assistants that make up the squad. The call will start with the first assistant in the list.
idstring
This is the unique identifier for the squad.
orgIdstring
This is the unique identifier for the org that this squad belongs to.
createdAtstringformat: "date-time"

This is the ISO 8601 date-time string of when the squad was created.

updatedAtstringformat: "date-time"

This is the ISO 8601 date-time string of when the squad was last updated.

namestring or null
This is the name of the squad.
membersOverridesobject or null

This can be used to override all the assistants’ settings and provide values for their template variables.

Both membersOverrides and members[n].assistantOverrides can be used together. First, members[n].assistantOverrides is applied. Then, membersOverrides is applied as a global override.