Skip to main content
PATCH
Toggle release form visibility

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Path Parameters

releaseFormId
integer
required
Required range: x > 0

Body

application/json
entityType
string
required

The type of release form. Values include link, document, user, and guest; other values may also be accepted.

Minimum string length: 1

Response

Successful response

entityId
number
required
entityType
string
required
isHidden
boolean
required
success
boolean
required