API Reference
Log In
API Reference

Add a Collaborator to a Folder (record)

Adds a Collaborator to a Folder (record), sends an Invitation email, and creates the collaboration network. An expiryDate parameter should also be specified to set a date on which the Collaborator's access to the Folder (record) will end. This endpoint should be used to add Collaborators that are of the "Account" or "Invitation" type.

🚧

Note

The use of this endpoint has been deprecated for "Team" Collaborator types. To add a Team as a Collaborator to a Folder (record), use the endpoint: /api/v2/networks/sidedrawer/sidedrawer-id/{sidedrawerId}/record/record-id/{recordId}/network

ℹ️

Versions

This endpoint also has a v2 version. Understand the difference here.

Path Params
string
required

Unique Drawer (sidedrawer) identifier.

string
required

Unique Folder (record) identifier.

Body Params
string
required

The User's role within the Folder (record). For example, "rec_editor".

contributor
object
required

The contributor(s) with some level of access to the entity.

string

The contributor type (Account, Team, Invitation).

relation
object
required

The contributor's relationship to the entity owner.

date-time
required

The expiry date of the contributor's access to the entity. This should be in ISO 8601 format.

Response

Language
Credentials