Skip to documentation

Inboxes API reference

Create collection destinations, retrieve inbox keys and configure inbox metadata.

Updated Read as Markdown

Inboxes organize collection

An inbox belongs to a brand and receives widget/API feedback. Its id identifies the management resource; its key goes in inboxKey when you collect an event.

All paths below start with https://api.pollenate.dev/organizations/ORG_ID/inboxes. Use an organization-wide key with X-Pollenate-Key. A brand-scoped key is not supported on these management routes.

Method and suffix Purpose Organization-key scope
GET / List inboxes; optional brandId filter read
GET /INBOX_ID Read one inbox read
POST / Create an inbox in a brand write
PATCH /INBOX_ID Update name, description, active state, theme or settings write
POST /INBOX_ID/regenerate-key Replace the collection key write
DELETE /INBOX_ID Delete the inbox and associated feedback admin

admin also grants the listed read/write operations. For a person working through MCP, use list_inboxes with their current brand access.

Create an inbox

bash
curl https://api.pollenate.dev/organizations/ORG_ID/inboxes \
  -H "X-Pollenate-Key: $POLLENATE_WRITE_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Documentation",
    "brandId": "BRAND_ID",
    "description": "Feedback from setup and API guides"
  }'

The name is required, 1–100 characters. brandId must belong to the requested organization. Optional fields are key (1–50 characters), description (up to 500 characters), themeId and a settings object. Omit key to generate one. A 201 response contains the new inbox's id, key, brandId, name and other metadata.

The active plan limits inboxes per brand. Exceeding that limit returns 403 with code: "PLAN_LIMIT_REACHED", limit and current. Invalid fields return 400; an unknown brand returns 404.

Rotate a collection key carefully

Regenerating an inbox key changes the destination identifier that installed widgets use. Update every embed or integration referencing the old key. This is separate from rotating the organization API key, which authenticates the request.

Verify the replacement by submitting a clearly identified test event and opening the inbox. Do not delete an inbox just to clear a configuration problem: deletion removes associated feedback. See workspace inboxes for the dashboard workflow.