Skip to main content
POST
Invite a user
KODE sends an invitation email only when the invitee already has an account in the organization you set in trustedOrganizationId. If not, the guest is created and no email is sent. Check the email address before you send the request.
The new user is a GUEST with active set to true and invitationStatus set to PENDING. You send no name. The user is ACCEPTED once the invitation is accepted. An app you assign to a pending guest stays PENDING until then.
trustedOrganizationId is the id of the guest’s home organization. The email address must not belong to a user who already exists in your organization.

Authorizations

Authorization
string
header
required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Body

application/json
trustedOrganizationId
string
required
Pattern: \S
email
string
required
Pattern: \S
role
string
required
Pattern: \S
position
string
Maximum string length: 200

Response

The invited guest. The response is 200, not 201.

_id
string
organizationId
string
createdAt
string
read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

updatedAt
string
read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

firstName
string
lastName
string
email
string
phone
string
position
string
role
string
memberType
string
active
boolean
invitationStatus
string
assignedInApps
object[]