Skip to main content
Edit document role or position

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

if-match
string

Optional strong ETag from the individual resource GET. A stale validator returns 412.

Required string length: 1 - 4096

Path Parameters

id
string<uuid>
required
document_id
string<uuid>
required

Body

application/json
role
enum<string>
Available options:
terms,
price_list,
uncategorized,
excluded
position
integer | null
Required range: 0 <= x <= 2147483647

Response

Current resource.

agreement_id
string<uuid>
required
document
object
required
role
enum<string>
required
Available options:
terms,
price_list,
uncategorized,
excluded
position
integer | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required