Pular para o conteúdo
AchaduDevelopers
API operacionalIr para o site
Painel
Developers/API/group_create
Groups

Criar destino de grupo

Registra um grupo já autorizado pelo conector da conta.

POST/groupsgroups:write
COMPORTAMENTO

A alteração é validada e persistida na conta da chave antes da resposta. Consulte o recurso retornado como fonte de verdade.

EFEITO

Pode alterar o recurso e emitir o evento de domínio correspondente.

REPETIÇÃO

Em falha de rede, confirme o estado do recurso antes de repetir. Refaça automaticamente apenas 429 e 5xx com backoff e jitter.

Solicitação

namestring · bodyNome do grupo.minLength 2 · maxLength 160obrigatório
external_idstring · bodyIdentificador retornado pelo conector; nunca volta na resposta.minLength 2 · maxLength 240obrigatório
connection_idstring · bodyConexão que administra o grupo.opcional
segment_idstring · bodySegmento inicial.opcional
rolestring · bodyPapel: envio, monitor ou ambos.opcional
capacityinteger · bodyCapacidade operacional.min 1 · max 1000000opcional
automationboolean · bodyAtiva automação.opcional
AuthorizationBearer ach_live_...
Acceptapplication/json
Escopogroups:write

Exemplo executável

curl
curl -X POST 'https://achadu.com/api/v1/groups' \
  -H 'Authorization: Bearer ach_live_...' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data '{
  "name": "My integration",
  "external_id": "string",
  "connection_id": "string",
  "segment_id": "string",
  "role": "string"
}'

Resposta e erros

Toda resposta inclui request_id. Listas acrescentam pagination; recursos mutáveis retornam o estado persistido após a operação.

201 application/json
{
  "data": {
    "id": "grp_01J...",
    "name": "Home deals",
    "members": 842,
    "active": 1,
    "capacity": 1024,
    "segment_id": "seg_01J..."
  },
  "created": true,
  "request_id": "req_01J..."
}
201Recurso criado e persistido.
400Parâmetro, corpo ou transição inválida.
401Chave ausente, inválida, expirada ou revogada.
402O plano da conta não libera esta interface.
403A chave precisa do escopo groups:write.
404Recurso inexistente nesta conta.
409O estado atual impede esta operação.
413O corpo JSON ultrapassa 128 KB.
429A janela de 120 solicitações por minuto foi excedida.