Add a Collaborator (including a Team) to a Folder (record)

post

https://api-sbx.sidedrawersbx.com/api/v2/networks/sidedrawer/sidedrawer-id/{sidedrawerId}/record/record-id/{recordId}/network

Adds a Collaborator (including of "Team" type) to a Folder (record). Use expiryDate to specify the date on which the Collaborator's access to the Folder (record) will end.

Path Params

sidedrawerId

string

required

Drawer (sidedrawer) identifier.

recordId

string

required

Unique Folder (record) identifier (if Item type is record).

Body Params

recordRole

string

required

Folder (record) role.

openId

string

Contributor OpenID. OpenID is an open standard authentication method used as identification for Users, like a username or email might be used.

relation

object

required

Relation object.

expiryDate

date-time

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

invitationCode

string

Invitation code.

teamId

string

Team identifier.

federationId

string

This is only applicable for enterprise implementations. The federationId identifies the institution. This is optional in this case; just for a scenario in which you need to create an user which will be federated later by an enterprise SSO connection.

region

string

Account region.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully added a Collaborator.