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:

PropertyTypeDescription
sharedObjectObject with keys users, teams, and/or domains.
shared.usersArrayA list of individual users with whom the root resource is shared.
shared.users.emailStringEmail of the user being shared with. Only exists if the user does not have a Mixmax account.
shared.users.userIdStringID of the user being shared with. Only exists if the user has a Mixmax account.
shared.users.acceptedBooleanIf the individual user has accepted this resource. If this is false, they will not see it in the UI.
shared.users.roleStringUser'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.teamsArrayArray of objects representing teams that this resource is shared with. Each object has the key _id.
shared.teams._idStringThe _id of the team that's shared with.
shared.teams.roleStringTeam'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.