Skip to main content
PUT
Update brief

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Path Parameters

id
string
required

Unique identifier for the brief that generated by system. Example: 6738a1f2c4e9b10012ab34cd

Body

multipart/form-data
name
string
required

Brief name, max 100 characters, unique in your organization (briefs in Trash do not count). Example: SOP Servis Berkala 10.000 km

type
enum<string>
required

Document type. Only pdf today.

Available options:
pdf
sourceType
enum<string>
required

link: the brief points to a URL. upload: the brief holds an uploaded PDF.

Available options:
link,
upload
_method
enum<string>

Send PUT here when you call this endpoint as POST /brief/{id}. Multipart bodies are only read on POST, so a client that uploads a file sends POST with _method=PUT.

Available options:
PUT
url
string

Required when sourceType is link. Must start with https://, max 2048 characters. Ignored for upload. Example: https://docs.example.com/oli-mesin-2026.pdf

file
file

The new PDF, max 20 MB. Leave it out to keep the stored PDF of an upload brief. Required when a link brief becomes upload.

roleIds[]
string[]

Role IDs that can see the brief, one field per role. Leave it out to show the brief to every role (this clears any roles set before).

Response

Success

status
boolean

Status of response.

message
string

Message of API response.

data
object

The updated brief.