Skip to navigation
Users & OrganizationsMemberships

Bulk update memberships

View as Markdown

Any field that can be updated on a membership individually can also be used to bulk update multiple memberships. Pass the comma-separated ids of the memberships to update into id__in in _params. For example:

{"_params": {"id__in": "memb_A,memb_B"}, "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p"}

Authentication

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
auto_record_callsenumOptional

Whether this member's calls are automatically recorded. Starts as unset and can be set to enabled or disabled.

Allowed values:
default_caller_idstring or nullOptional

ID of the phone number to use as this member's default outbound caller ID. Close keeps this value while default_caller_id_mode is auto, but outbound calls do not use it.

default_caller_id_modeenumOptional

How this member's outbound caller ID is chosen. In fixed mode, outbound calls use default_caller_id. In auto mode, Close derives the number for each call and ignores default_caller_id.

Allowed values:
hangup_recording_urlstring or nullOptional
URL of the audio file used as this member's voicemail drop recording.
may_workflows_impersonatebooleanOptional
Whether Workflows may send emails on this member's behalf.
role_idstringOptional

One of admin, superuser, user, or restricteduser for the corresponding predefined role, or the ID of a custom Role.

track_email_opensbooleanOptional
Whether email opens are tracked for emails this member sends.

Response

Successful response

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error