Skip to main content
POST
Reactivate a deactivated subscription

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

subscriptionId
string
obrigatório

Unique subscription identifier.

Resposta

OK

adoptedVersion
string
obrigatório

Version of the document this tenant generates against

Exemplo:

"1.0.0"

adoptionHistory
object[] | null
obrigatório

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

bindingVersion
integer<int64>
obrigatório

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

Exemplo:

3

createdAt
string<date-time>
obrigatório

Creation timestamp in UTC

Exemplo:

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

documentId
string
obrigatório

Curated document this subscription files

Exemplo:

"br.bcb.cadoc-4010"

id
string
obrigatório

Unique subscription identifier

Exemplo:

"00000000-0000-0000-0000-000000000000"

status
string
obrigatório

active or inactive

Exemplo:

"active"

updatedAt
string<date-time>
obrigatório

Most recent update timestamp in UTC

Exemplo:

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

version
integer<int64>
obrigatório

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

Exemplo:

1

deactivatedAt
string<date-time>

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

Exemplo:

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

deactivatedBy
string

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

Exemplo:

"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.

Exemplo:

"00000000-0000-0000-0000-000000000000"

reactivatedAt
string<date-time>

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

Exemplo:

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

reactivatedBy
string

Authenticated subject that last reactivated it; absent if never

Exemplo:

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