CLclose
memberships

Update a membership

Changed on
put/membership/{id}/

Request

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

Path parameters

idstring required

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

auto_record_calls'enabled' | 'disabled' | 'unset' required
default_caller_idstring nullable required
default_caller_id_mode'fixed' | 'auto' required

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 required
idstring required
may_workflows_impersonateboolean required
onboarding_statusstring nullable required
organization_idstring required
permissions_grantedPermission[]
primary_personal_numberstring nullable required
rolestring
role_idstring required
track_email_opensboolean required
user_emailstring
user_first_namestring nullable
user_full_namestring nullable
user_google_profile_image_urlstring nullable
user_idstring required
user_imagestring nullable
user_last_namestring nullable
user_phonestring nullable

Phone number in E.164 format.

user_phone_formattedstring nullable
user_totp_auth_state'enabled' | 'disabled' | 'blocked'

Changes

  • 2ff98656cc2aRevision 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 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

  • 22110b3147beRevision changes
    • warning

      added the new manage_oauth_connections enum value to the / response property for the response status