Push document into user view

Tries to push a document to the logged in user identified by userId. If the user is not logged in the request will be discarded. The pushed document must be in the state ACTIVE or ARCHIVED. By setting useLatestVersion to true, the newest version of an instruction which is either in the state ACTIVE or ARCHIVED will be pushed to the user. A lang parameter can be send in the body to determine the language of the Document which will be opened. A HTTP 404 Not Found error will be returned if no user with userId or no valid Document with documentId exists. A HTTP 400 Bad Request error will be returned if useLatestVersion is either not set or false while the Instruction is not in the state ACTIVE or ARCHIVED.

Path Params
integer
required
1 to 9007199254740991
string
required
length between 1 and 100

Consists of the subdomain. The tenantId for https://company.operations1.app/ is company.

Body Params
integer
required
1 to 9007199254740991
integer
1 to 9007199254740991
boolean
string
enum
Headers
required

Defines the API version. Using a date is recommended for stability. Avoid using latest in production, as it refers to the most up-to-date functionality, which may include breaking changes. For more details, see our article on versioning.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json