v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Users

Create Current Org User

Creates a new user in the caller's current organization and assigns the requested permissions roles.

The new user receives an invitation email prompting them to set up their account. Role assignments take effect as soon as the invitation is accepted.

post/api/organization/users

Headers

X-Polytomic-Versionstring

Request body

emailstring required

Email address used to sign the user in and receive notifications.

rolestring

Deprecated legacy role name. Use role_ids instead; setting both role and role_ids in the same request is rejected.

role_idsstring[]

Identifiers of the permissions roles to assign to the user. Must contain at least one entry when provided.

Example request

{
  "email": "mail@example.com",
  "role": "admin",
  "role_ids": [
    "248df4b7-aa70-47b8-a036-33ac447e668d"
  ]
}

Response

OK

Example response

{
  "data": {
    "email": "mail@example.com",
    "role": "admin",
    "role_ids": [
      "248df4b7-aa70-47b8-a036-33ac447e668d"
    ]
  }
}