memberships

Bulk update memberships

Changed on

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"}
put/membership/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/membership/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Request body

auto_record_calls'enabled' | 'disabled' | 'unset'
default_caller_idstring nullable

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_mode'fixed' | 'auto'

How a caller's outbound number is chosen. Fixed uses a single configured number; Auto lets Close select the best number per call/SMS (Managed by Close Caller ID).

hangup_recording_urlstring nullable

URL of the audio file used as this member's Voicemail Drop recording.

may_workflows_impersonateboolean

Whether Workflows may send emails on this member's behalf.

role_idstring

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

track_email_opensboolean

Whether email opens are tracked for emails this member sends.

Response

Successful response

Changes

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the new optional request property