CIcint
Projects

Update a project

This endpoint updates the details of an existing project.

To prevent race conditions, this endpoint uses optimistic locking. You must provide the If-Match header with the ETag value of the resource you intend to update.

You can get the latest ETag by performing a GET request on the project first.

put/demand/accounts/{account_id}/projects/{project_id}

Request

Headers

If-Matchstring etag required
Example:W/"1234"

The ETag value of the resource, used for optimistic locking.

Providing the ETag ensures you don't accidentally overwrite changes made by another request. You can get this value from the ETag header of a GET request for the resource.

idempotency-keystring required

A shallow unique ID used as part of the deduplication mechanism for mutable operations. We suggest using UUIDv4 or another random string with sufficient entropy to avoid collisions.

Example:01BTGNYV6HRNK8K8VKZASZCFP0

A shallow unique ID used as part of the deduplication mechanism for mutable operations, this header is required.

Request body

namestring required

The name of the project. Any leading or trailing whitespace will be trimmed.

project_manager_idstring uuid required

A unique identifier for the user.

project_customer_reference_numberstring nullable required

A customer-provided reference number assigned to the project.

:::danger Deletion Warning If this field is omitted from the request body during an update, the existing customer reference number will be permanently deleted. :::

Example request

{
  "name": "A Project",
  "project_manager_id": "b551326b-ac9d-4d32-8823-4f025787dab9",
  "project_customer_reference_number": "RF-4567"
}

Response

Returns the updated project's id and human_readable_id.

idstring

The character string representing a unique project ID (ULID format).

human_readable_idstring

The project's human-readable ID. This ID is unique within the scope of an account.

Example response

{
  "id": "01BTGNYV6HRNK8K8VKZASZCFP0",
  "human_readable_id": "FT354J"
}

Changes

No recorded changes to this operation across all 1 revision of this API.