Create user

POST/v2/users

Adds a user to the organization with the given role and sends them an invite email. If the email address already belongs to an Axiom account, Axiom keeps its existing name. API tokens can't assign the owner role.

Body

Object representing a new user creation request

application/json

Property	Type	Description
`email`	`string`Required	Email address of the new user
`name`	`string`Required	Full name of the new user
`role`	`string`Required	Role to assign to the new user

Request

curl -X POST 'https://api.axiom.co/v2/users' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"email":"jane.doe@example.com","name":"Jane Doe","role":"member"}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token RequiredRequest body application/json

Response

200Added user.

application/json

400Invalid email address, the user is already a member, or the organization has reached its user limit.

403Insufficient permissions, or the caller isn't allowed to assign the `owner` role.

404Role not found.

Property	Type	Description
`email`	`string`Required	User's email address
`id`	`string`Required	Unique identifier for the user
`name`	`string`Required	User's full name
`role`	`object`Required	Detailed information about a user's role
`id`	`string`Required	Unique identifier for the role
`name`	`string`Required	Human-readable name of the role