Skip to main content
POST
/
members
Create a member
curl --request POST \
  --url https://api.tomorro.com/members \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "username": "jsmith@example.com",
  "role": "user",
  "groupIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "sendInvitation": false
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "username": "jsmith@example.com",
      "firstname": "<string>",
      "lastname": "<string>"
    },
    "role": "user",
    "status": "active",
    "contracts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "role": "creator",
        "status": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
Creates a new member in your organization.

​
Request Body

FieldTypeRequiredDescription
usernamestringYesEmail address for the new member
rolestringYesMember role: user, manager, or admin
groupIdsstring[]NoList of group UUIDs to assign the member to
sendInvitationbooleanNoSend an invitation email (default: false)

​
Roles

RoleDescription
userStandard user with basic permissions
managerCan manage contracts and team workflows
adminFull administrative access
When sendInvitation is true, the new member will receive an email invitation to join your organization. The member’s status will be pending until they accept the invitation.

Authorizations

​
x-api-key
string
header
required

Your Tomorro API key. You can generate one from your organization settings.

Body

application/json

Request body for creating a new member

​
username
string<email>
required

Email address for the new member

​
role
enum<string>
required

The role of the member within the organization

Available options:
user,
manager,
admin
​
groupIds
string<uuid>[]

List of group IDs to assign the member to

​
sendInvitation
boolean
default:false

Whether to send an invitation email to the new member

Response

Member created successfully

API response wrapper for a single member

​
data
object
required

A member of your organization