Pular para o conteúdo

POST /v1/group-launches/{id}/actions

POST
/v1/group-launches/{id}/actions
curl --request POST \
--url https://seu-endereco-da-api/v1/group-launches/example/actions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "action": "lock", "groupIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "params": { "phones": [ "example" ], "name": "example", "description": "example", "photoKey": "example" } }'

Permissão que a Chave de acesso precisa: Gerenciar grupos de lançamento (group-launches:manage).

id
required
string
Media typeapplication/json
object
action
required
string
Allowed values: lock unlock remove_participants set_name set_description set_photo
groupIds
Array<string>
>= 1 items
params
object
phones
Array<string>
>= 1 items <= 1000 items
name
string
>= 1 characters <= 100 characters
description
string
<= 2000 characters
photoKey
string
>= 1 characters <= 512 characters
Media typeapplication/json
object
commandId
required
string
total
required
number
summary
required
string

Example generated

{
"commandId": "example",
"total": 1,
"summary": "example"
}

Missing params for the action, or no group can receive it