Skip to main content
POST
Perform Squad Action

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

squad_uuid
string
required

Body

application/json

Request to perform squad action.

action
enum<string>
required
Available options:
add_all_users,
remove_all_users,
delete,
rename,
update_inbounds
name
string | null
inbound_uuids
string[] | null

Response

Successful Response

Response after squad operation.

success
boolean
required
message
string | null
data
Data · object | null