Skip to main content
POST
/
members
Create a member
curl --request POST \
  --url http://localhost:3015/members \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user": {
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe"
  },
  "role": "USER",
  "groupIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "sendInvitation": true
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "role": "ADMIN",
  "status": "active",
  "user": {
    "email": "john.doe@example.com",
    "firstname": "John",
    "lastname": "Doe"
  },
  "groupIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-02T00:00:00.000Z"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your key at https://app.tomorro.com/settings/api

Body

application/json
​
user
object
required

The user account information for the new member.

Example:
{
  "email": "john.doe@example.com",
  "firstName": "John",
  "lastName": "Doe"
}
​
role
enum<string>
required

Member role. USER: Standard user with basic permissions. MANAGER: Can manage contracts and team workflows. ADMIN: Full administrative access.

Available options:
USER,
MANAGER,
ADMIN
Example:

"USER"

​
groupIds
string[]

List of group UUIDs to assign the member to

Example:
["550e8400-e29b-41d4-a716-446655440000"]
​
sendInvitation
boolean
default:false

Send an invitation email to the new member. When true, the member will receive an email invitation and their status will be pending until they accept.

Example:

true

Response

Member created successfully

​
id
string
required

Unique identifier for the member.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
role
enum<string>
required

The role assigned to this member, which determines their permissions.

  • USER: Standard user with basic access to view and interact with contracts.
  • MANAGER: Can create, edit, and manage contracts and workflows.
  • ADMIN: Full administrative access including member management and organization settings.
Available options:
USER,
MANAGER,
ADMIN
Example:

"ADMIN"

​
status
enum<string>
required

The current status of the member.

  • active: The member has accepted their invitation and can access the platform.
  • disabled: The member has been deactivated and cannot access the platform.
  • pending: The member has been invited but has not yet accepted.
Available options:
active,
disabled,
pending
Example:

"active"

​
user
object
required

The user account associated with this member.

Example:
{
  "email": "john.doe@example.com",
  "firstname": "John",
  "lastname": "Doe"
}
​
groupIds
string[]
required

List of group UUIDs the member belongs to.

Example:
["550e8400-e29b-41d4-a716-446655440000"]
​
createdAt
string<date-time>

Time at which the member was created. Formatted as an ISO 8601 date-time string.

Example:

"2024-01-01T00:00:00.000Z"

​
updatedAt
string<date-time>

Time at which the member was last updated. Formatted as an ISO 8601 date-time string.

Example:

"2024-01-02T00:00:00.000Z"