> For a complete page index, fetch https://developer.close.com/llms.txt # Update a membership PUT https://api.close.com/api/v1/membership/{id}/ Content-Type: application/json Reference: https://developer.close.com/api/resources/memberships/update ## Authentication - `Authorization` header (basic auth, required) — Use your API key as the username and leave the password empty. - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `id` (string, required) ### Body (application/json) This endpoint expects a Membership. - `auto_record_calls` (enum, optional) — Whether this member's calls are automatically recorded. Starts as `unset` and can be set to `enabled` or `disabled`. - Allowed values: `enabled`, `disabled`, `unset` - `default_caller_id` (string, optional, 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` (enum, optional) — 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: `fixed`, `auto` - `hangup_recording_url` (string, optional, nullable) — URL of the audio file used as this member's voicemail drop recording. - `may_workflows_impersonate` (boolean, optional) — Whether Workflows may send emails on this member's behalf. - `role_id` (string, optional) — One of `admin`, `superuser`, `user`, or `restricteduser` for the corresponding predefined role, or the ID of a custom [Role](https://developer.close.com/api/resources/roles). - `track_email_opens` (boolean, optional) — Whether email opens are tracked for emails this member sends. ## Response ### 200 Successful response - `auto_record_calls` (enum, required) - Allowed values: `enabled`, `disabled`, `unset` - `default_caller_id` (string, required, nullable) - `default_caller_id_mode` (enum, 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). - Allowed values: `fixed`, `auto` - `hangup_recording_url` (string, required, nullable) - `id` (string, required) - `may_workflows_impersonate` (boolean, required) - `onboarding_status` (string, required, nullable) - `organization_id` (string, required) - `primary_personal_number` (string, required, nullable) - `role_id` (string, required) - `track_email_opens` (boolean, required) - `user_id` (string, required) - `permissions_granted` (list of enum, optional) - Allowed values: `manage_organization`, `manage_own_api_keys`, `manage_others_api_keys`, `manage_customizations`, `manage_oauth_apps`, `manage_group_numbers`, `manage_team_smart_views`, `manage_team_email_templates`, `manage_email_sequences`, `ai_enrich`, `bulk_import`, `bulk_email`, `bulk_enrich`, `bulk_sequence_subscriptions`, `bulk_edit`, `bulk_delete`, `export`, `merge_leads`, `delete_leads`, `manage_others_opportunities`, `delete_own_opportunities`, `manage_others_tasks`, `delete_own_tasks`, `view_voice_agents`, `manage_voice_agents`, `ai_chat`, `manage_chloe_call_tasks`, `view_custom_agents`, `manage_custom_agents`, `manage_others_activities`, `delete_own_activities`, `calling`, `call_coach_listen`, `call_coach_barge`, `view_all_leads`, `manage_web_forms` - `role` (string, optional) - `user` (MembershipUser, optional) — A user nested in a membership response. - `user_email` (string, optional) - `user_first_name` (string, optional, nullable) - `user_full_name` (string, optional, nullable) - `user_google_profile_image_url` (string, optional, nullable) - `user_image` (string, optional, nullable) - `user_last_name` (string, optional, nullable) - `user_phone` (string, optional, nullable) — Phone number in E.164 format. - `user_phone_formatted` (string, optional, nullable) - `user_totp_auth_state` (enum, optional) - Allowed values: `enabled`, `disabled`, `blocked` ## Errors ### 400 Bad Request Error Bad request - `any` ### 401 Unauthorized Error Unauthorized - `any` ### 404 Not Found Error Not found - `any` ## Types ### MembershipUser A user nested in a membership response. - `email` (string, required) - `first_name` (string, required, nullable) - `full_name` (string, required, nullable) - `google_profile_image_url` (string, required, nullable) - `id` (string, required) - `image` (string, required, nullable) - `last_name` (string, required, nullable) - `totp_auth_state` (enum, required) - Allowed values: `enabled`, `disabled`, `blocked` ## Examples **Request** ```json { "auto_record_calls": "enabled", "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p" } ``` **Response** ```json { "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" ] } ``` **SDK Code** ```python memberships_update_example import requests url = "https://api.close.com/api/v1/membership/id/" payload = { "auto_record_calls": "enabled", "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p" } headers = { "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers, auth=("", "")) print(response.json()) ``` ```javascript memberships_update_example const url = 'https://api.close.com/api/v1/membership/id/'; const credentials = btoa(":"); const options = { method: 'PUT', headers: {Authorization: `Basic ${credentials}`, 'Content-Type': 'application/json'}, body: '{"auto_record_calls":"enabled","role_id":"role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go memberships_update_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.close.com/api/v1/membership/id/" payload := strings.NewReader("{\n \"auto_record_calls\": \"enabled\",\n \"role_id\": \"role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p\"\n}") req, _ := http.NewRequest("PUT", url, payload) req.SetBasicAuth("", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby memberships_update_example require 'uri' require 'net/http' url = URI("https://api.close.com/api/v1/membership/id/") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request.basic_auth("", "") request["Content-Type"] = 'application/json' request.body = "{\n \"auto_record_calls\": \"enabled\",\n \"role_id\": \"role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p\"\n}" response = http.request(request) puts response.read_body ``` ```java memberships_update_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://api.close.com/api/v1/membership/id/") .basicAuth("", "") .header("Content-Type", "application/json") .body("{\n \"auto_record_calls\": \"enabled\",\n \"role_id\": \"role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p\"\n}") .asString(); ``` ```php memberships_update_example request('PUT', 'https://api.close.com/api/v1/membership/id/', [ 'body' => '{ "auto_record_calls": "enabled", "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p" }', 'headers' => [ 'Content-Type' => 'application/json', ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp memberships_update_example using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://api.close.com/api/v1/membership/id/"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.PUT); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"auto_record_calls\": \"enabled\",\n \"role_id\": \"role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ```