Memberships

Memberships connects a User with one or more Organizations. A Membership is created when a User is added to an organization, and it becomes "inactive" when a User leaves or is removed from an Organization.

Update membership.

PUT /membership/{id}/

You can update the field role_id and its value can be one of 'admin', 'superuser', 'user' or 'restricteduser' for the corresponding predefined role, or an ID of a Role. The field auto_record_calls is used to manage whether or not calls are automatically recorded. The initial value for a membership is 'unset'. It can be updated to 'disabled', or 'enabled'.

Create or activate a membership for the given email

POST /membership/

Ensures an active membership for the given email will be provisioned.

• If the user already exists, they will be added to the requestor's organization.
• If it doesn't exist, a new user will be provisioned.

role_id can be one of 'admin', 'superuser', 'user' or 'restricteduser' for the corresponding predefined role, or an ID of a Role.

This request requires "Manage Organization" permissions.

API access to this endpoint is supported via OAuth only.

Bulk-update memberships.

PUT /membership/

Any field that can be updated on a membership individually can also be used to bulk update multiple memberships. To issue a bulk update, pass their comma separated ids into id__in in _params as shown in the example below.

Get pinned views for membership.

GET /membership/{id}/pinned_views

Get the ordered list of pinned views for the given membership.

Set pinned views for membership.

PUT /membership/{id}/pinned_views

Set the pinned views for the given membership. Provide an ordered list that will overwrite the entire current list.