Skip to main content
PUT
Add a company member

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Company external ID

userId
string
required

User external ID

environmentId
string
required

Environment ID

projectId
string
required

Project ID

Body

application/json
attributes
object

Custom attributes to set on the membership (e.g. the user's role in the company). Each key must be a valid codeName: start with a letter, then letters/digits/underscores, 2–100 chars.

Response

Membership created or updated (echoed)

id
string
required

Internal membership record id (not addressable anywhere) — join on userId/companyId instead.

object
enum<string>
required
Available options:
companyMembership
attributes
object
required
createdAt
string<date-time>
required
companyId
string
required

External company id — the id companies are addressed by.

userId
string
required

External user id — the id users are addressed by.

user
object