Scopes — Segments
API Key permissions for dynamic audiences (segments:*).
Esta página foi útil?
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
API Key permissions for dynamic audiences (segments:*).
segments:*. Reading contacts within a segment requires contacts:read (members route).| Scope | Allows |
|---|---|
segments:read | GET /v1/segments, GET /v1/segments/{id}, GET /v1/segments/{id}/preview |
segments:create | POST /v1/segments |
segments:update | PUT /v1/segments/{id} |
segments:delete | DELETE /v1/segments/{id} |
| Flow | Scopes |
|---|---|
| Audience dashboard | segments:read, contacts:read |
| CRM creates segments + exports | segments:read, segments:create, contacts:read |
| Full management | segments:* |
| Code | Cause |
|---|---|
| 403 | Missing segments:read or segments:create |
| 400 | Invalid definition (rule missing tagId / topicId) |
403 PLAN_LIMIT_CRM | Segment limit for the plan |
Esta página foi útil?
