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",
  "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"
  ],
  "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.

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](/resources/roles/). This request requires "Manage Organization" permissions. API access to this endpoint is supported via OAuth only.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

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