Company membership

Bulk-invite a member across companies

Invites the same email (with one role) to multiple companies at once, sharing a single invitation token. All target companies must be authorized for the caller and must define the requested role; assigning the owner role requires the caller to be an owner of each company. A maximum of 50 companies per request is enforced. Conflicts (email already a member somewhere) return 422 with the offending company ids.

post/v1/company_memberships/create_many

Request

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

Parameters

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

Request body

emailstring email required
rolestring required
company_idsstring[] required

Up to 50 company UUIDs to invite the email into.

Example request

{
  "role": "member"
}

Response

The created memberships (one per company).

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.