Create a membership

POST

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

POST

/api/v1/membership/

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,
  "default_caller_id_mode": "fixed",
  "hangup_recording_url": null,
  "id": "memb_JPCqDJq0AmoZFhemXAWrWk9327DqfJgUF2VGPMOL4Lp",
  "may_workflows_impersonate": false,
  "onboarding_status": "in-progress",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "primary_personal_number": null,
  "role_id": "user",
  "track_email_opens": true,
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "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"
}

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.

This request requires “Manage Organization” permissions.

As a security precaution, this operation requires the organization to have the “Restrict new users to emails from these domains” setting enabled, and the new member’s email address must belong to one of its verified domains.

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. This request requires "Manage Organization" permissions. As a security precaution, this operation requires the organization to have the "Restrict new users to emails from these domains" setting enabled, and the new member's email address must belong to one of its verified domains.

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

One of superuser, user, or restricteduser for the corresponding predefined role, or the ID of a custom Role. The role must not grant the manage_organization permission.

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

403

Forbidden Error

404

Not Found Error