Skip to main content
POST
Add a team member

Authorizations

Authorization
string
header
required

Use the Authorization header with Bearer scheme.

Examples:

  • API Key: Authorization: Bearer calid_xxxxx

Path Parameters

teamId
integer
required

Numeric team identifier.

Required range: x > 1
Example:

42

Body

application/json
userId
integer
required

User identifier to add as a team member.

Required range: x > 1
Example:

321

role
enum<string>
default:MEMBER

Role granted to the team member.

Available options:
MEMBER,
ADMIN,
OWNER
Example:

"MEMBER"

acceptedInvitation
boolean
default:false

Whether the invitation is already accepted.

Example:

false

impersonation
boolean
default:true

Whether impersonation capabilities are enabled for this membership.

Example:

true

Response

Team membership created successfully

Team membership created successfully

success
enum<boolean>
required
Available options:
true
data
object
message
string
meta
object