Create a membership | Close | Developer API Documentation

curl -X POST https://api.close.com/api/v1/membership/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "email": "john@salesteam.com",
  "role_id": "user"
}'

{
  "auto_record_calls": "unset",
  "default_caller_id": null,
  "hangup_recording_url": null,
  "id": "memb_JPCqDJq0AmoZFhemXAWrWk9327DqfJgUF2VGPMOL4Lp",
  "is_free": false,
  "may_workflows_impersonate": false,
  "onboarding_status": "in-progress",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "permissions_granted": [
    "bulk_email",
    "bulk_import",
    "bulk_sequence_subscriptions",
    "calling",
    "delete_leads",
    "delete_own_activities",
    "delete_own_opportunities",
    "delete_own_tasks",
    "manage_others_activities",
    "manage_others_opportunities",
    "manage_others_tasks",
    "merge_leads",
    "view_all_leads"
  ],
  "primary_personal_number": null,
  "role": "user",
  "role_id": "user",
  "track_email_opens": true,
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

Ensures an active membership for the given email will be provisioned. - If the user already exists, they will be added to the requestor's organization. - If it doesn't exist, a new user will be provisioned. `role_id` 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). This request requires "Manage Organization" permissions. API access to this endpoint is supported via OAuth only.

curl -X POST https://api.close.com/api/v1/membership/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "email": "john@salesteam.com",
  "role_id": "user"
}'

{
  "auto_record_calls": "unset",
  "default_caller_id": null,
  "hangup_recording_url": null,
  "id": "memb_JPCqDJq0AmoZFhemXAWrWk9327DqfJgUF2VGPMOL4Lp",
  "is_free": false,
  "may_workflows_impersonate": false,
  "onboarding_status": "in-progress",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "permissions_granted": [
    "bulk_email",
    "bulk_import",
    "bulk_sequence_subscriptions",
    "calling",
    "delete_leads",
    "delete_own_activities",
    "delete_own_opportunities",
    "delete_own_tasks",
    "manage_others_activities",
    "manage_others_opportunities",
    "manage_others_tasks",
    "merge_leads",
    "view_all_leads"
  ],
  "primary_personal_number": null,
  "role": "user",
  "role_id": "user",
  "track_email_opens": true,
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

Ensures an active membership for the given email will be provisioned.

If the user already exists, they will be added to the requestor’s organization.
If it doesn’t exist, a new user will be provisioned.

role_id can be one of 'admin', 'superuser', 'user' or 'restricteduser' for the corresponding predefined role, or an ID of a Role.

This request requires “Manage Organization” permissions.

API access to this endpoint is supported via OAuth only.

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.

Request

This endpoint expects an object.

emailstringRequiredformat: "email"

role_idstringRequired>=1 character

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl -X POST https://api.close.com/api/v1/membership/ \
>	-H "Content-Type: application/json" \
>	-u "<CLOSE_API_KEY>:" \
>	-d '{
>	"email": "john@salesteam.com",
>	"role_id": "user"
>	}'

1	{
2	"auto_record_calls": "unset",
3	"default_caller_id": null,
4	"hangup_recording_url": null,
5	"id": "memb_JPCqDJq0AmoZFhemXAWrWk9327DqfJgUF2VGPMOL4Lp",
6	"is_free": false,
7	"may_workflows_impersonate": false,
8	"onboarding_status": "in-progress",
9	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
10	"permissions_granted": [
11	"bulk_email",
12	"bulk_import",
13	"bulk_sequence_subscriptions",
14	"calling",
15	"delete_leads",
16	"delete_own_activities",
17	"delete_own_opportunities",
18	"delete_own_tasks",
19	"manage_others_activities",
20	"manage_others_opportunities",
21	"manage_others_tasks",
22	"merge_leads",
23	"view_all_leads"
24	],
25	"primary_personal_number": null,
26	"role": "user",
27	"role_id": "user",
28	"track_email_opens": true,
29	"user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
30	}