Update a membership

PUT

https://api.close.com/api/v1/membership/:id/

PUT

/api/v1/membership/:id/

curl -X PUT https://api.close.com/api/v1/membership/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "auto_record_calls": "enabled",
  "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p"
}'

{
  "auto_record_calls": "enabled",
  "default_caller_id": null,
  "default_caller_id_mode": "fixed",
  "hangup_recording_url": null,
  "id": "memb_SLfZq4IU5E2nBA3PBzHFsi1HUv98cPmGUIZGlWK7Z3y",
  "may_workflows_impersonate": false,
  "onboarding_status": "done",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "primary_personal_number": "phon_nm67bxYRTJUZNOXflc1I3bBadd0PbQvvui1byxCwK7k",
  "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
  "track_email_opens": true,
  "user_id": "user_A3HwmEOcDLL8ilFx8QKcYEuKDtRPtBuQ68PctqwMqtP",
  "permissions_granted": [
    "bulk_delete",
    "bulk_edit",
    "export",
    "manage_customizations",
    "manage_group_numbers",
    "manage_organization",
    "manage_team_smart_views"
  ]
}

Authentication

AuthorizationBasic

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

AuthorizationBearer

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

Path parameters

idstringRequired

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.

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.

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

auto_record_callsenum

default_caller_idstring or null

default_caller_id_modeenum

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 or null

idstring

may_workflows_impersonateboolean

onboarding_statusstring or null

organization_idstring

primary_personal_numberstring or null

role_idstring

track_email_opensboolean

user_idstring

permissions_grantedlist of enumsOptional

rolestringOptional

userobjectOptional

A user nested in a membership response.

user_emailstringOptional

user_first_namestring or nullOptional

user_full_namestring or nullOptional

user_google_profile_image_urlstring or nullOptional

user_imagestring or nullOptional

user_last_namestring or nullOptional

user_phonestring or nullOptional

Phone number in E.164 format.

user_phone_formattedstring or nullOptional

user_totp_auth_stateenumOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error