Skip to main content
PUT
Set the institution that files a subscription

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

If-Match
string

Subscription version the caller read, from its ETag. Required.

Path Parameters

subscriptionId
string
required

Unique subscription identifier.

Body

application/json
institution
string

Institution that files the document. Omitted, the tenant's only institution; "all" is refused.

Example:

"00000000-0000-0000-0000-000000000000"

Response

OK

adoptedVersion
string
required

Version of the document this tenant generates against

Example:

"1.0.0"

adoptionHistory
object[] | null
required

Append-only record of which version was adopted, by whom and when

bindingVersion
integer<int64>
required

Version of the mapping in force, the one its ETag carries; 0 when none was written

Example:

3

createdAt
string<date-time>
required

Creation timestamp in UTC

Example:

"2026-01-01T00:00:00Z"

documentId
string
required

Curated document this subscription files

Example:

"br.bcb.cadoc-4010"

id
string
required

Unique subscription identifier

Example:

"00000000-0000-0000-0000-000000000000"

status
string
required

active or inactive

Example:

"active"

updatedAt
string<date-time>
required

Most recent update timestamp in UTC

Example:

"2026-01-01T00:00:00Z"

version
integer<int64>
required

Version of the subscription; setting its institution presents it as If-Match. 0 on a subscription never written since versions were counted.

Example:

1

deactivatedAt
string<date-time>

When the subscription was last deactivated, in UTC; absent if never

Example:

"2026-01-01T00:00:00Z"

deactivatedBy
string

Authenticated subject that last deactivated it; absent if never, or if that request identified nobody

Example:

"acme/00000000-0000-0000-0000-000000000000"

institutionId
string

Institution that files the document. Absent on a subscription made before filings named an institution: it generates for the tenant's only institution, and with none or several it waits until one is set.

Example:

"00000000-0000-0000-0000-000000000000"

reactivatedAt
string<date-time>

When the subscription was last reactivated, in UTC; absent if never

Example:

"2026-01-01T00:00:00Z"

reactivatedBy
string

Authenticated subject that last reactivated it; absent if never

Example:

"acme/00000000-0000-0000-0000-000000000000"