Sign in
Company membership

Remove a company membership

Removes a member from the company by marking the membership canceled. Any of the member's pending cards for that company are unassigned. The request fails with 422 if the member still has active or inactive (non-canceled, non-pending) cards — those must be canceled first.

delete/v1/company_memberships/{id}

Path parameters

idstring required

The id of the resource. This is a UUID for most resources, but for user endpoints it is the user's Firebase UID (an opaque string), so no uuid format is asserted here.

Parameters

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

Response

The canceled 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 endpoint across all 1 revision of this API.