Skip to main content

What is Brief?

A brief is a reference PDF, such as an SOP, a product guide or a campaign brief, that your field team reads in the mobile app. It comes from an https link or an uploaded PDF (max 20 MB), and it is shared with chosen roles or with every role. These endpoints are served under /api/v4. Read briefs needs no permission and returns only what the caller may see: the owner gets every brief, every other role (admins included) gets the briefs for its own role plus the briefs for every role.

Key Features

Read briefs

GET /briefs

Create brief

POST /brief

Read brief by ID

GET /brief/

Update brief

PUT /brief/

Delete brief

DELETE /brief/