Skip to main content
PATCH
Update member

Authorizations

x-api-key
string
header
required

API key for authentication. Get your key at https://app.tomorro.com/settings/integrations?integration=api-key

Path Parameters

id
string
required

The unique identifier (UUID) of the member to update

Example:

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

Body

application/json
role
enum<string>

New role for the member. USER: Standard user. MANAGER: Can manage contracts. ADMIN: Full access.

Available options:
USER,
MANAGER,
ADMIN
Example:

"MANAGER"

status
enum<string>

New status for the member. active: Can access the platform. disabled: Cannot access. pending: Awaiting invitation acceptance.

Available options:
active,
disabled,
pending
Example:

"active"

groupIds
string[]

List of group UUIDs to assign the member to. Replaces existing group assignments.

Example:
folderIds
string[]

List of folder UUIDs to assign the member to. Replaces existing folder assignments.

Example:
firstname
string

First name of the member

Example:

"John"

lastname
string

Last name of the member

Example:

"Doe"

email
string

Email address of the member

Example:

"john.doe@example.com"

resendInvitation
boolean

Resend invitation email to a pending member

Example:

true

substituteId
string<uuid> | null

UUID of a member to act as substitute (for out-of-office).

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

Response

Updated member details

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:
groupIds
string[]
required

List of group UUIDs the member belongs to.

Example:
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"