Grupy
Utwórz miejsce docelowe grupy
Rejestruje grupę już autoryzowaną przez łącznik konta.
POST
/groupsgroups:writeZACHOWANIE
Zmiana zostanie zweryfikowana i utrwalona na koncie kluczowym przed udzieleniem odpowiedzi. Zapytaj zwrócony zasób jako źródło prawdy.
EFEKT
Może zmienić zasób i wyemitować odpowiednie zdarzenie domeny.
POWTÓRKA
W przypadku awarii sieci potwierdź stan zasobu przed ponowną próbą. Automatycznie ponawiaj tylko 429 i 5xx z cofaniem i jitterem.
Żądanie
namestring · bodyNazwa grupy.minLength 2 · maxLength 160obowiązkoweexternal_idstring · bodyIdentyfikator zwracany przez łącznik; nigdy nie odpowiada.minLength 2 · maxLength 240obowiązkoweconnection_idstring · bodyPołączenie zarządzające grupą.opcjonalnesegment_idstring · bodySegment początkowy.opcjonalnerolestring · bodyRola: wysyłka, monitorowanie lub jedno i drugie.opcjonalnecapacityinteger · bodyZdolność operacyjna.min 1 · max 1000000opcjonalneautomationboolean · bodyAktywuje automatyzację.opcjonalneAuthorization
Bearer ach_live_...Accept
application/jsonZakres
groups:writePrzykład wykonywalny
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"
}'Odpowiedź i błędy
Każda odpowiedź zawiera request_id. Listy dodają paginację; zasoby modyfikowalne zwracają utrwalony stan po operacji.
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..."
}201Zasób został utworzony i utrwalony.400Nieprawidłowy parametr, treść lub przejście.401Brakujący, nieprawidłowy, wygasły lub unieważniony klucz.402Plan konta nie udostępnia tego interfejsu.403A chave precisa do escopo groups:write.404Funkcja nie istnieje na tym koncie.409Obecny stan uniemożliwia tę operację.413Treść JSON przekracza 128 KB.429Przekroczono okno 120 żądań na minutę.