CLclose
memberships

Create a membership

Changed on

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.

post/membership/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/membership/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Request body

emailstring email required
role_idstring required

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_calls'enabled' | 'disabled' | 'unset' required
default_caller_idstring nullable required
default_caller_id_mode'fixed' | 'auto' 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).

hangup_recording_urlstring nullable required
idstring required
may_workflows_impersonateboolean required
onboarding_statusstring nullable required
organization_idstring required
permissions_grantedPermission[]
primary_personal_numberstring nullable required
rolestring
role_idstring required
track_email_opensboolean required
user_emailstring
user_first_namestring nullable
user_full_namestring nullable
user_google_profile_image_urlstring nullable
user_idstring required
user_imagestring nullable
user_last_namestring nullable
user_phonestring nullable

Phone number in E.164 format.

user_phone_formattedstring nullable
user_totp_auth_state'enabled' | 'disabled' | 'blocked'

Changes

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

  • 22110b3147beRevision changes
    • warning

      added the new manage_oauth_connections enum value to the / response property for the response status