Skip to main content
PATCH
/
members
/
{id}
Update a member
curl --request PATCH \
  --url https://api.tomorro.com/members/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "role": "user",
  "groupIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "resendInvitation": true,
  "substituteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "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"
  }
}
Updates an existing member’s role, group assignments, or other properties.

​
Path Parameters

ParameterTypeDescription
idstring (UUID)The unique identifier of the member to update

​
Request Body

FieldTypeRequiredDescription
rolestringYesNew role: user, manager, or admin
groupIdsstring[]NoList of group UUIDs to assign
resendInvitationbooleanNoResend invitation email to pending members
substituteIdstringNoUUID of a member to act as substitute (or null to remove)

​
Use Cases

​
Change member role

Promote a user to manager: 
{
  "role": "manager"
}

​
Assign to groups

Add member to specific groups: 
{
  "role": "user",
  "groupIds": [
    "550e8400-e29b-41d4-a716-446655440000",
    "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  ]
}

​
Resend invitation

Resend invitation to a pending member: 
{
  "role": "user",
  "resendInvitation": true
}

​
Set substitute

Assign another member as substitute (for out-of-office): 
{
  "role": "user",
  "substituteId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
The role field is required in every update request, even if you’re not changing it.

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

The unique identifier of the member

Body

application/json

Request body for updating a 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

​
resendInvitation
boolean

Whether to resend the invitation email

​
substituteId
string<uuid> | null

ID of a member to act as substitute

Response

Member updated successfully

API response wrapper for a single member

​
data
object
required

A member of your organization