Company membership

Create a company membership (invite)

Creates a membership for a company, generating an invitation token and sending the invitation email. When the invitee already exists they are linked; otherwise a pending invitation (no user_id) is created for the email.

post/v1/company_memberships

Request

Base URL
https://api.cardda.com
URL
https://api.cardda.com/v1/company_memberships
Auth
HTTP bearer

Parameters

#/paths/~1v1~1users/get/parameters/0 (unresolved $ref)

Request body

emailstring email required

rolestring required

company_idstring uuid required

legal_representativeboolean

has_powers_to_actboolean

partnerboolean

partner_typeinteger

participation_ratenumber

is_indirect_participation_corporateboolean

identification_filestring

Attachment (identification document).

power_filestring

Attachment (powers document).

Example request

{
  "role": "member"
}

Response

The created membership.

idstring uuid required

user_idstring nullable

Firebase UID of the member. Null while the invitation is still pending.

company_idstring uuid required

emailstring nullable

rolestring

Role name (e.g. owner, admin, member, or a custom company role name).

status'pending' | 'active' | 'canceled'

legal_representativeboolean

has_powers_to_actboolean nullable

partnerboolean

partner_typeinteger nullable

participation_ratenumber nullable

Ownership participation percentage (0-100).

is_indirect_participation_corporateboolean nullable

company_role_idstring uuid nullable

created_atstring date-time

updated_atstring date-time

Example response

{
  "role": "member",
  "status": "active"
}

Changes

No recorded changes to this operation across all 1 revision of this API.