Board Inbox

View as Markdown

Enable Inbox

POST/api/v1/board/{board_id}/inbox/enable

Enable public inbox on a board. Generates token + optional slug.

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl -X POST "https://app.opvs.ai/api/v1/board/{board_id}/inbox/enable" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Rotate Token

POST/api/v1/board/{board_id}/inbox/rotate-token

Rotate the inbox token. Old token stops working immediately.

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl -X POST "https://app.opvs.ai/api/v1/board/{board_id}/inbox/rotate-token" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Register Opvs Address

POST/api/v1/board/{board_id}/inbox/opvs/register

Register an OPVS address for a board inbox. Auto-generates if address is None.

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl -X POST "https://app.opvs.ai/api/v1/board/{board_id}/inbox/opvs/register" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Get Inbox Config

GET/api/v1/board/{board_id}/inbox

Get current inbox config for a board (owner view with token).

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl "https://app.opvs.ai/api/v1/board/{board_id}/inbox" \
  -H "Authorization: Bearer $OPVS_TOKEN"

List Submissions

GET/api/v1/board/{board_id}/inbox/submissions

Get paginated submission audit log for a board.

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl "https://app.opvs.ai/api/v1/board/{board_id}/inbox/submissions" \
  -H "Authorization: Bearer $OPVS_TOKEN"

Public Submit By Token

POST/api/v1/public/inbox/{token}/submit

Submit a task to a board via inbox token. No auth required.

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl -X POST "https://app.opvs.ai/api/v1/public/inbox/{token}/submit" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Public Submit By Slug

POST/api/v1/public/inbox/s/{slug}/submit

Submit a task to a board via inbox slug. No auth required.

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl -X POST "https://app.opvs.ai/api/v1/public/inbox/s/{slug}/submit" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Public Config By Token

GET/api/v1/public/inbox/{token}/config

Get public-safe inbox config for widget/landing page initialization.

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl "https://app.opvs.ai/api/v1/public/inbox/{token}/config" \
  -H "Authorization: Bearer $OPVS_TOKEN"

Public Config By Slug

GET/api/v1/public/inbox/s/{slug}/config

Get public-safe inbox config by slug.

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl "https://app.opvs.ai/api/v1/public/inbox/s/{slug}/config" \
  -H "Authorization: Bearer $OPVS_TOKEN"

Widget Js

GET/api/v1/public/inbox/widget.js

Serve the embeddable inbox widget JavaScript.

Request
curl "https://app.opvs.ai/api/v1/public/inbox/widget.js" \
  -H "Authorization: Bearer $OPVS_TOKEN"

Landing Page By Slug

GET/api/v1/public/inbox/s/{slug}

Serve the public inbox landing page by slug.

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl "https://app.opvs.ai/api/v1/public/inbox/s/{slug}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

Landing Page By Token

GET/api/v1/public/inbox/{token}

Serve the public inbox landing page by token.

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl "https://app.opvs.ai/api/v1/public/inbox/{token}" \
  -H "Authorization: Bearer $OPVS_TOKEN"
Did this answer your question?