Groups
Atualizar grupo
Atualiza nome, segmento, capacidade e automação.
PATCH
/groups/{id}groups:writeCOMPORTAMENTO
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
idstring · pathIdentificador do recurso.minLength 2 · maxLength 100obrigatórionamestring · bodyNome do grupo.opcionalrolestring · bodyPapel do grupo.opcionalsegment_idstring · bodySegmento.opcionalcapacityinteger · bodyCapacidade.opcionalautomationboolean · bodyAtiva automação.opcionalactiveboolean · bodyAtiva o grupo.opcionalAuthorization
Bearer ach_live_...Accept
application/jsonEscopo
groups:writeExemplo executável
curl
curl -X PATCH 'https://achadu.com/api/v1/groups/resource_id' \
-H 'Authorization: Bearer ach_live_...' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data '{
"name": "My integration",
"role": "string",
"segment_id": "string"
}'Resposta e erros
Toda resposta inclui request_id. Listas acrescentam pagination; recursos mutáveis retornam o estado persistido após a operação.
200 application/json
{
"data": {
"id": "grp_01J...",
"name": "Home deals",
"members": 842,
"active": 1,
"capacity": 1024,
"segment_id": "seg_01J..."
},
"request_id": "req_01J..."
}200Operação concluída.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.