For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETList Current Org Users
      • POSTCreate Current Org User
      • GETGet Current Org User
      • PUTUpdate Current Org User
      • DELDelete Current Org User
      • GETList Partner Users
      • POSTCreate Partner User
      • GETGet Partner User
      • PUTUpdate Partner User
      • DELDelete Partner User
      • POSTCreate Partner User API Key
Logo
Log inBook a demo
API ReferenceUsers

Create Partner User

POST
https://app.polytomic.com/api/organizations/:org_id/users
POST
/api/organizations/:org_id/users
$curl -X POST https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "email": "jane.doe@acmecorp.com"
>}'
1{
2  "data": {
3    "email": "jane.doe@acmecorp.com",
4    "id": "a3f1c9e2-7b4d-4f6a-9c2e-1d2f3b4a5c6d",
5    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
6    "role_ids": [
7      "d9f8e7c6-b5a4-4321-9f8e-7d6c5b4a3e2f"
8    ],
9    "role": "admin"
10  }
11}
Creates a new user in the specified organization and assigns the requested permissions roles. > 🚧 Requires partner key > > User endpoints are only accessible using [partner keys](../../../../guides/obtaining-api-keys#partner-keys). 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.
Was this page helpful?
Previous

Get Partner User

Next

Creates a new user in the specified organization and assigns the requested permissions roles.

🚧 Requires partner key

User endpoints are only accessible using partner keys.

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.

Authentication

AuthorizationBearer
Bearer partner API key

Path parameters

org_idstringRequiredformat: "uuid"
Unique identifier of the organization the user belongs to.

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.
emailstringRequired
Email address used to sign the user in and receive notifications.
role_idslist of stringsOptional
Identifiers of the permissions roles to assign to the user. Must contain at least one entry when provided.
rolestringOptionalDeprecated

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

Response

OK
dataobject

Errors

403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error