Other

Create a link a named person can open, so an agent can hand its work to an…

POSThttps://backend.immut.io/api/v1/share-links

Required scope: documents:write

Create a link a named person can open, so an agent can hand its work to an investor or adviser. Recipients are required, because a link without them cannot be opened and naming them is what makes access attributable. An expiry is required too: permanent access to a customer's documents is not something an agent should be able to create by omission.

Request body

Content type: application/json (required)

Field	Type	Required	Description
`resourceType`	string	yes	document \| folder \| workspace (required)
`resourceId`	string	yes	the id of the thing to share (required)
`recipientEmails`	string	yes	array of the people who may open it (required, at least one)
`expiresInDays`	string	yes	1 to 365 (required). A link an agent creates must expire
`accessLevel`	string	no	view \| download (default view)

Responses

Status	Meaning
`201`	Created. `url` is the link to send. Returns: id, url, resourceType, resourceId, accessLevel, recipientEmails, expiresAt, delivery. Each recipient confirms a code sent to their email before the link opens, and access is logged per email address rather than per device. `delivery` says plainly that immut does NOT email the link from this endpoint: you must send the url to the recipients yourself.
`400`	BadRequest
`401`	Unauthorized
`403`	Forbidden
`429`	RateLimited

Example

curl -X POST "https://backend.immut.io/api/v1/share-links" \
  -H "Authorization: Bearer $IMMUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resourceType":"<resourceType>","resourceId":"<resourceId>","recipientEmails":"<recipientEmails>","expiresInDays":"<expiresInDays>","accessLevel":"<accessLevel>"}'

Generated from the immut API contract, version 1.14.0. Machine-readable: this page as markdown · everything in one file · OpenAPI