Skip to main content
POST
/
api
/
teams
/
{id}
/
invite
Invite a user to a team
curl --request POST \
  --url https://platform.kodexa.ai/api/teams/{id}/invite \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "jsmith@example.com",
  "firstName": "<string>",
  "lastName": "<string>"
}
'
{
  "invited": true,
  "teamMemberId": "<string>",
  "userId": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Body

application/json
​
email
string<email>
required
​
firstName
string
​
lastName
string

Response

Invitation result

​
invited
boolean
​
teamMemberId
string
​
userId
string