Droits (scopes)
Ce que chaque droit permet, et les opérations qui l'exigent.
Une clé d'API ou une connexion OAuth porte des droits. Une opération qui en exige un qu'elle n'a pas répond 403 insufficient_scope, avec required_scopes. Les droits marqués « engage » font partir quelque chose, dépensent des crédits ou modifient une campagne. Une nouvelle clé reçoit les droits marqués « donné par défaut » ; sends:write se coche en connaissance de cause. À la connexion d'une application, chaque droit demandé est affiché et se décoche.
account:read
Lire votre activité et vos statistiques
Donné par défaut à une nouvelle clé.
Opérations : GET /v1/accounts, GET /v1/overview, GET /v1/credits, GET /v1/campaigns, GET /v1/campaigns/{id}, GET /v1/campaigns/{id}/stats
prospects:read
Lire vos prospects et votre CRM
Donné par défaut à une nouvelle clé.
Opérations : GET /v1/prospects, POST /v1/prospects/search, GET /v1/prospects/{id}, GET /v1/prospects/{id}/timeline, GET /v1/prospects/{id}/notes, GET /v1/stages, GET /v1/lists, GET /v1/suppressions, GET /v1/imports/{id}, GET /v1/enrichment_jobs/{id}, GET /v1/events, GET /v1/events/{id}
contacts:read
Voir les e-mails et téléphones trouvés
Donné par défaut à une nouvelle clé.
Aucune opération ne l'exige à elle seule : il ajoute le champ contact (e-mails, téléphone) à chaque prospect rendu par l'API, aux charges des webhooks et au connecteur IA.
conversations:read
Lire vos conversations
Donné par défaut à une nouvelle clé.
Opérations : GET /v1/conversations, GET /v1/conversations/{id}, GET /v1/conversations/{id}/messages
prospects:write
Modifier votre CRM (étapes, listes, rappels, notes)
Donné par défaut à une nouvelle clé.
Opérations : PUT /v1/prospects, PATCH /v1/prospects/{id}, DELETE /v1/prospects/{id}, POST /v1/prospects/{id}/notes, PATCH /v1/prospects/{id}/notes/{note_id}, DELETE /v1/prospects/{id}/notes/{note_id}, PUT /v1/prospects/{id}/external_ids, POST /v1/stages, PATCH /v1/stages/{id}, DELETE /v1/stages/{id}, POST /v1/lists, PATCH /v1/lists/{id}, DELETE /v1/lists/{id}, POST /v1/lists/{id}/members, DELETE /v1/lists/{id}/members/{prospect_id}, POST /v1/suppressions, DELETE /v1/suppressions/{id}, POST /v1/imports, POST /v1/test/reset, POST /v1/test/simulate
sends:write
Envoyer des invitations et des messages en votre nom, dans vos limites d'envoi (engage votre compte)
Opérations : POST /v1/prospects/{id}/approve_invitation, POST /v1/prospects/{id}/approve_message, POST /v1/prospects/{id}/messages
enrichment:write
Utiliser vos crédits d'enrichissement (engage votre compte)
Donné par défaut à une nouvelle clé.
Opérations : POST /v1/enrichment_jobs, POST /v1/prospects/{id}/enrich
campaigns:write
Modifier vos campagnes (engage votre compte)
Donné par défaut à une nouvelle clé.
Opérations : PATCH /v1/campaigns/{id}
webhooks:manage
Gérer les webhooks
Donné par défaut à une nouvelle clé.
Opérations : GET /v1/webhook_endpoints, POST /v1/webhook_endpoints, GET /v1/webhook_endpoints/{id}, PATCH /v1/webhook_endpoints/{id}, DELETE /v1/webhook_endpoints/{id}, POST /v1/webhook_endpoints/{id}/rotate_secret, POST /v1/webhook_endpoints/{id}/test, GET /v1/webhook_endpoints/{id}/deliveries, POST /v1/webhook_endpoints/{id}/deliveries/{delivery_id}/retry