Scopes
Scope list
Section titled “Scope list”| Scope | Family | Minimum key | Endpoints |
|---|---|---|---|
ingest:write |
ingest | Publishable | POST /ingest/event, POST /ingest/identify. Secret key needed for POST /ingest/sale, POST /ingest/order-status and reorder requests |
inventory:write |
inventory-ingest | Secret | POST /ingest/inventory |
products:read |
products | Publishable | /products/top/{range}, /products/{id}, /products/search, /products/trending |
recommendations:read |
products | Publishable | /recommendations, /recommendations/model |
reviews:read |
reviews | Publishable | /reviews |
locations:read |
locations | Publishable | /locations |
markets:read |
markets | Publishable | /markets |
visitor:read |
visitor | Secret | /visitor/{reference}/profile, /visitor/{reference}/segments |
catalog:read |
catalog | Secret | /catalog |
availability:read |
catalog | Secret | /products/{id}/availability |
dealers:read |
dealers | Secret | /dealers, /dealers/{id} |
dealer-performance:read |
dealer-performance | Secret | /dealers/performance/{range}, /dealers/lapse-risk |
store-performance:read |
store-performance | Secret | /stores/{range}, /stores/{range}/{storeId} |
audience-performance:read |
audience-performance | Secret | /audiences/{range}, /audiences/{range}/{audienceId}/trend |
customer-sales:read |
customer-sales | Secret | /customers/sales/{range}, /orders/requests |
contact-interest:read |
contact-interest | Secret | /contacts/interest, /contacts/interest/top/{range} |
forecast:read |
forecasting | Secret | /forecast/restock, /forecast/top/{range}, /products/{id}/forecast/{range}, /forecast/similarity, /forecast/similarity/{id} |
enrich:read |
enrich | Secret | POST /enrich/contact |
comcol:read |
comcol | Secret | /comcol/requests, /comcol/requests/{id} |
images:read |
images | Secret | GET /images and the other image reads |
images:write |
images | Secret | Image creation, edits, approval, export and upload |
All paths are under https://api.plunk.io/cx/v1.
How scopes and families combine
Section titled “How scopes and families combine”A family appears in your capabilities document only when all three are true:
- The family is enabled for your account’s data. For example, locations and store performance need a retail channel, and dealers need wholesale sales.
- The key’s class allows it. Publishable keys never see secret families.
- The key holds the family’s scope.
A call outside those rules gets 403 { "error": "scope_not_permitted", "scope": "…" }.
Related
Section titled “Related”Was this helpful?
Still stuck? Contact support and include the job or page you were on.