GEgettruss
Projects

Update project

Changed on

Update a project

put/projects/{id}

Request

  • Base URL
    https://app2.gettruss.io/api/v1
  • URL
    https://app2.gettruss.io/api/v1/projects/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

ID of the project to update

Request body

project_namestring
metadataobject
idempotency_keystring

Optional idempotency key - this must be unique across firm's projects

reminder_schedulestring

Set the project reminder schedule (case-insensitive). One of: Standard, All Off (alias: Project and Payments Off), "Project Off, Payment On" (alias: "Project Off, Payments On"), Daily, Every other day, Every 4 days, Weekly, Every other week, Every 3 weeks, Monthly. Custom schedules are not supported.

karbon_work_item_idstring

Link the project to this Karbon work-item key. Connection and work-item verification, plus integration-task discovery, happen asynchronously. Blank values do not unlink a project.

Response

successful

Changes

  • 88923d59dcc5Revision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 7c956b3d1bdfRevision changes
    • breaking

      the response property / became nullable for the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status