Passer au contenu principal
PATCH
Modifier un groupe

Autorisations

x-api-key
string
header
requis

Clé API d’authentification. Créez-en une ici.

Paramètres de chemin

group_id
string<uuid>
requis

Identifiant unique du groupe

Corps

application/json

Corps de modification d’un groupe. Au moins un champ requis.

name
string

Nouveau nom du groupe.

Minimum string length: 1
Exemple:

"Renamed Group"

add_website_ids
string<uuid>[]

ID de sites à ajouter au groupe, de votre organisation. Les sites déjà membres sont ignorés silencieusement.

Minimum array length: 1
Exemple:
remove_website_ids
string<uuid>[]

ID des sites à retirer du groupe. Ceux qui n’en font pas partie sont ignorés silencieusement.

Minimum array length: 1
Exemple:
external_id
string | null

Partenaires uniquement. Identifiant partenaire à associer au groupe. Une chaîne non vide définit ou remplace l’association ; null l’efface. Accepté uniquement avec une clé API d’organisation partenaire. Un client direct reçoit 403 Forbidden. Doit être unique par type de ressource dans l’organisation ; une valeur déjà utilisée par un autre groupe renvoie 409 avec la ressource existante.

Minimum string length: 1
Exemple:

"acct_9e4c1b8d"

billing_enabled
boolean

Définissez sur true pour activer la facturation de ce groupe. Provisionne une entité de facturation chez le fournisseur en amont, préalable à l’attribution de crédits au groupe (opération réservée aux partenaires). Idempotent — peut être appelé sans risque sur des groupes dont l’entité n’a jamais été créée ou dont le provisionnement initial a échoué silencieusement. Définissez sur false pour désactiver l’indicateur sans détruire l’état de facturation existant ; les soldes de crédits et l’historique d’utilisation sont conservés. Renvoie 502 si le fournisseur de facturation ne parvient pas à provisionner l’entité — la base n’est alors pas modifiée et la requête peut être réessayée proprement.

Exemple:

true

Réponse

Groupe mis à jour. Les réponses partenaires incluent externalId (chaîne ou null) ; celles des clients directs omettent le champ.

group
object
requis

Groupe de sites de votre organisation