Passer au contenu principal
POST
Créer un groupe

Autorisations

x-api-key
string
header
requis

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

Corps

application/json

Corps de création d’un groupe

name
string
requis

Nom du groupe.

Minimum string length: 1
Exemple:

"Enterprise Clients"

website_ids
string<uuid>[]
requis

ID des sites du groupe. Tous doivent appartenir à votre organisation. Les doublons sont réduits à une appartenance.

Minimum array length: 1
Exemple:
billing_enabled
boolean
défaut:false

Indique s’il faut activer la facturation pour ce groupe

Exemple:

false

external_id
string

Partenaires uniquement. Identifiant de votre système à associer au groupe Athena. Clé d’organisation partenaire requise ; client direct : 403 Forbidden. Unique par type de ressource ; doublon : 409 avec la ressource existante.

Minimum string length: 1
Exemple:

"acct_9e4c1b8d"

Réponse

Groupe créé avec succès

group
object
requis

Nouvelle ressource de groupe

billingEntityCreated
boolean

Présent uniquement avec billing_enabled demandé : existence de l’entité après provisionnement. Si faux, création échouée malgré relance ; définir les crédits du groupe renvoie 400 jusqu’à réparation par PATCH /api/v1/groups/{group_id} avec billing_enabled: true.