Projects

Update a project

Rename a project, recolour it, change its description, and change who it is shared with. Jobs reference a project by ID, so a rename keeps every job already filed under it — which is why renaming is the right way to correct a name, rather than creating a second project and splitting the history. Only the project's CREATOR may change it; org membership alone is not enough. That rule is the boundary here, and it is the same one whether you authenticate with a session or an API key: every field below is available to both. Membership (addMembers, removeMembers) applies to a PERSONAL-scoped project only — an organization project is already visible to the whole organization, so member changes on one are accepted and silently do nothing. Read the result back with GET /projects/members/list.

put/api/projects/update

Request

  • Base URL: https://app.tamarind.bio
  • URL: https://app.tamarind.bio/api/projects/update
  • Auth: API key in header x-api-key

Request body

projectIdstring required

The project's ID, as returned by GET /projects/list.

namestring

New name, unique within the scope the project lives in.

descriptionstring
colorstring

Hex colour for the UI.

addMembersstring[]

Emails to invite, on a personal-scoped project. Addresses outside your organization, and your own, are dropped silently. Must be an array if present.

removeMembersstring[]

Emails to revoke, on a personal-scoped project. Must be an array if present.

Response

Updated.

failedAddsstring[]

Present only when an invitation could not be written. Every other change in the request still applied.

Changes

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