Appendix: Shared resources

Many resources (such as contactgroups) can be shared, or accessible by users other than the creator. If a resource is shared, it will have a shared key in the following format:

Property

Type

Description

shared

Object

Object with keys users, teams, and/or domains.

shared.users

Array

A list of individual users with whom the root resource is shared.

shared.users.email

String

Email of the user being shared with. Only exists if the user does not have a Mixmax account.

shared.users.userId

String

ID of the user being shared with. Only exists if the user has a Mixmax account.

shared.users.accepted

Boolean

If the individual user has accepted this resource. If this is false, they will not see it in the UI.

shared.users.role

String

User's access level for the resource. Possible values are:

  • 'read-only'
  • 'read-write'

If the resource is shared with a user individually and with their team, they will receive whichever access level is the highest.

shared.teams

Array

Array of objects representing teams that this resource is shared with. Each object has the key _id.

shared.teams._id

String

The _id of the team that's shared with.

shared.teams.role

String

Team's access level for the resource. Possible values are:

  • 'read-only'
  • 'read-write'

If the resource is shared with a user individually and with their team, they will receive whichever access level is the highest.