Update a company project

patch

https://gateway.remote.com/v1/projects/{id}

Updates a single contractor project by its ID.

Omitted fields are left unchanged. lead_ids and team_member_ids are replaced wholesale
when present, so send the complete desired list rather than only the additions, and send an
empty list to remove everyone. Read the project first to get its current membership.

Authentication

This endpoint requires the following token type:

Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage timeoffs (`time_and_attendance`)	-	Manage projects (`project:write`)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Project identifier

Body Params

Project fields to update

Fields to update on a company project. Every field is optional; omitted fields are left
unchanged.

lead_ids and team_member_ids are replaced wholesale when present, so send the complete
desired list rather than only the additions. Send an empty list to remove everyone. Fetch
the project first to read its current membership.

description

string | null

Description of the project.

end_date

date | null

Date when the project ends.

lead_ids

array of objects

User IDs of the company admins to assign as the project's leads, replacing the current set. These are user IDs, unlike team_member_ids, which are employment IDs.

lead_ids

name

string

Name of the project.

start_date

date | null

Date when the project starts.

status

string

enum

Allowed:

team_member_ids

array of objects

Employment IDs of the contractors to assign as the project's team members, replacing the current set. These are employment IDs, unlike lead_ids, which are user IDs. Each must be an active contractor of the project's company.

team_member_ids

Responses

Callback

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Entity