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"
> }'

1 {
2   "auto_record_calls": "enabled",
3   "id": "memb_SLfZq4IU5E2nBA3PBzHFsi1HUv98cPmGUIZGlWK7Z3y",
4   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
5   "permissions_granted": [
6     "bulk_delete",
7     "bulk_edit",
8     "export",
9     "manage_customizations",
10     "manage_group_numbers",
11     "manage_organization",
12     "manage_team_smart_views"
13   ],
14   "plan_type": "enterprise",
15   "primary_personal_number": "phon_nm67bxYRTJUZNOXflc1I3bBadd0PbQvvui1byxCwK7k",
16   "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
17   "user_id": "user_A3HwmEOcDLL8ilFx8QKcYEuKDtRPtBuQ68PctqwMqtP"
18 }

You can update the field `role_id` and its value can be one of `'admin'`, `'superuser'`, `'user'` or `'restricteduser'` for the corresponding predefined role, or an ID of a [Role](https://developer.close.com/api/resources/roles). The field `auto_record_calls` is used to manage whether or not calls are automatically recorded. The initial value for a membership is `'unset'`. It can be updated to `'disabled'`, or `'enabled'`.

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",
  "id": "memb_SLfZq4IU5E2nBA3PBzHFsi1HUv98cPmGUIZGlWK7Z3y",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "permissions_granted": [
    "bulk_delete",
    "bulk_edit",
    "export",
    "manage_customizations",
    "manage_group_numbers",
    "manage_organization",
    "manage_team_smart_views"
  ],
  "plan_type": "enterprise",
  "primary_personal_number": "phon_nm67bxYRTJUZNOXflc1I3bBadd0PbQvvui1byxCwK7k",
  "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
  "user_id": "user_A3HwmEOcDLL8ilFx8QKcYEuKDtRPtBuQ68PctqwMqtP"
}

You can update the field role_id and its value can be one of 'admin', 'superuser', 'user' or 'restricteduser' for the corresponding predefined role, or an ID of a Role.

The field auto_record_calls is used to manage whether or not calls are automatically recorded. The initial value for a membership is 'unset'. It can be updated to 'disabled', or 'enabled'.

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 any.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	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"
>	}'

1	{
2	"auto_record_calls": "enabled",
3	"id": "memb_SLfZq4IU5E2nBA3PBzHFsi1HUv98cPmGUIZGlWK7Z3y",
4	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
5	"permissions_granted": [
6	"bulk_delete",
7	"bulk_edit",
8	"export",
9	"manage_customizations",
10	"manage_group_numbers",
11	"manage_organization",
12	"manage_team_smart_views"
13	],
14	"plan_type": "enterprise",
15	"primary_personal_number": "phon_nm67bxYRTJUZNOXflc1I3bBadd0PbQvvui1byxCwK7k",
16	"role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
17	"user_id": "user_A3HwmEOcDLL8ilFx8QKcYEuKDtRPtBuQ68PctqwMqtP"
18	}