project.archive

Beta

This endpoint is in beta and may not be available for all organizations.

Archives a project.
The effective actor must have permission to edit the project, including authorized on-behalf-of requests.
Calling this endpoint on an already archived project succeeds. Candidate memberships, history, authorship, confidentiality, descriptions, and custom-field values are preserved.
This endpoint does not permanently delete projects or candidates.

Requires the projectsWrite permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The project's unique identifier.

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json