Company Membership

Update user membership (company API)

post
/company/membership

Subscribe, unsubscribe, or terminate a user's membership for a company. The company is identified by its secret API key, and the user is identified by email. If the user does not exist for this company, they are created automatically.

Authorizations
x-api-keystringRequired

Company secret API key. The backend also supports passing this in the Authorization header as Bearer <key> or in the apiKey query param.

Body
emailstring · emailRequired

User email used to find or create the user for this company.

first_namestringOptional

User first name (used only when creating a new user).

last_namestringOptional

User last name (used only when creating a new user).

plan_uuidstring · uuidOptional

Plan UUID. Required when type is subscribe.

typestring · enumRequired

Membership operation type.

Possible values:
Responses
chevron-right
200

Membership updated successfully

application/json
successbooleanOptionalExample: true
messagestringOptionalExample: Membership updated successfully
datastringOptionalExample: success
post
/company/membership

Last updated