Contractors
Projects

Update a company project

Changed on

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

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage projects (projects)-Manage projects (project:write)
patch/v1/projects/{id}

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/projects/{id}
  • Auth: OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, project:write, projects, all:write)

Path parameters

idstring uuid required

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Project identifier

Request body

descriptionstring nullable

Description of the project.

end_datestring date nullable

Date when the project ends.

lead_idsUuidSlug[]

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.

namestring

Name of the project.

start_datestring date nullable

Date when the project starts.

status'active' | 'archived' | 'completed'
team_member_idsUuidSlug[]

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.

Example request

{
  "lead_ids": [
    "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
  ],
  "name": "Website redesign",
  "status": "active",
  "team_member_ids": [
    "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
  ]
}

Response

Success

Example response

{
  "data": {
    "project": {
      "budget": {
        "amount": 250000,
        "currency": "USD"
      },
      "code": "WEB-001",
      "description": "Redesign the company website",
      "end_date": null,
      "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "lead_ids": [
        "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
      ],
      "name": "Website redesign",
      "start_date": "2026-01-01",
      "status": "active",
      "team_member_ids": [
        "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
      ]
    }
  }
}

Changes

  • 1692cde18808Revision changes
    • info

      the security scope projects was added to the endpoint's security scheme OAuth2AuthorizationCode

    • info

      the security scope time_and_attendance was removed from the endpoint's security scheme OAuth2AuthorizationCode

  • a7aa0c0e220bRevision changes
    • warning

      the request property's maxLength was set to 255

    • warning

      the request property's maxLength was set to 255

    • info

      added the optional property // to the response with the status