All APIs

Update project settings

Projects View as Markdown

PATCH/api/project/{projectId}

Updates profile (name/fullName/purpose), visibility (isPublic) and holiday settings. Admin + project member only.

Parameters

projectIdintegerpathRequired
The project ID.

Request body

namestring
Project key: 3 to 30 characters of letters, numbers, _, - and .. Must be unique in the space.
fullNamestring
Display name of the project (up to 255 characters).
purposestring
Purpose or description of the project (up to 10,000 characters).
isPublicboolean
Whether anyone with the public URL can view the task list without signing in. Member names and icons become public too.
holidaysobject[]
Project-specific holidays (up to 366). Replaces the existing list.
regularHolidaysinteger[]
Weekdays that are non-working every week, where 0 is Sunday and 6 is Saturday. Replaces the existing list. New projects use [0, 6].
avatarUrlnull
Pass null to remove the project icon.
backgroundUrlnull
Pass null to remove the project background image.
productImageUrlnull
Pass null to remove the project product image.

Responses

  • 200Updated project detail
  • 400Validation error or project name already exists
  • 401Authentication is required
  • 403Admin only
  • 404Project not found

Repsona uses cookies to provide our services. By visiting our website, you agree to the use of cookies as described in our Cookie Policy.