Activepieces Management Octri Preview
POST/v1/user-invitations

Send a user invitation

Creates or updates an invitation for a user, depending on whether an invitation already exists. Provide either a project invitation with type, email, projectId, and projectRole, or a platform invitation with type, email, and platformRole.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

Invitation details for either a project or the platform; provide the fields for one invitation type.

emailstringrequired
projectIdstringrequired
projectRolestringrequired
typestringrequired
Allowed:PROJECT

1 status code
201Returns the created or updated invitation, including its identifier, email, status, type, platform identifier, and invitation link.
createdstringrequired
emailstringrequired
idstringrequired
linkstringoptional
platformIdstringrequired
platformRolestringoptional
Allowed:ADMINMEMBEROPERATOR
projectIdstringoptional
projectRoleobjectoptional
projectRoleIdstringoptional
statusstringrequired
Allowed:PENDINGACCEPTED
typestringrequired
Allowed:PLATFORMPROJECT
updatedstringrequired

Error handling

For a project invitation, type, email, projectId, and projectRole are required, and type must be PROJECT. For a platform invitation, type, email, and platformRole are required, type must be PLATFORM, and platformRole must be ADMIN, MEMBER, or OPERATOR.