---
title: "Unarchive project"
method: PUT
path: "/projects/{id}/unarchive"
tags: ["Projects"]
---

# Unarchive project

`PUT /projects/{id}/unarchive`

## Request

- Base URL: `https://api.pipelinecrm.com/api/v3`
- URL: `https://api.pipelinecrm.com/api/v3/projects/{id}/unarchive`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `app-key`
  - API key in query parameter `api_key` and API key in query parameter `app_key`

Restores an archived project back to active status. Also accepts `PATCH`.

## Path parameters

- `id` integer, required

## Response `200`

Successful Response

- ProjectAll
  - `id` integer: Unique identifier
  - `archived_at` string, nullable: Timestamp when the project was archived, or null if active
  - `is_sample` boolean: Whether this project was created from sample data seeded for the account
  - `is_archived` boolean: Whether the project is currently archived
  - `is_active` boolean: Whether the project is currently active (not archived)
  - `created_by_user_id` integer, nullable: The ID of the [user](#tag/users) who created this project
  - `owner` object, nullable: A convenience object for the project [owner](#tag/users)
    - `id` integer
    - `first_name` string
    - `last_name` string
    - `email` string
  - `created_by_user` object, nullable: A convenience object for the [user](#tag/users) who created this project
    - `id` integer
    - `first_name` string
    - `last_name` string
  - `counts` object: Count of associated records
    - `collaborators` integer
    - `milestones` integer
    - `deals` integer
    - `companies` integer
    - `people` integer
  - `stats` object: Project progress statistics
    - `milestones_completed` integer
    - `todos_completed` integer
    - `todos_total` integer
    - `overdue_tasks` integer
    - `days_left` integer, nullable
    - `days_planned` integer, nullable
  - `deals` object[]: Associated [deals](#tag/deals) with summary info (show endpoint only)
    - `id` integer
    - `name` string
    - `value` number, float, nullable
    - `stage` string, nullable
    - `owner` string, nullable
    - `company` string, nullable
    - `expected_close_date` string, nullable
    - `status` string, nullable
  - `companies` object[]: Associated [companies](#tag/companies) with summary info (show endpoint only)
    - `id` integer
    - `name` string
    - `owner` string, nullable
    - `city` string
    - `state` string
    - `country` string
  - `people` object[]: Associated [people](#tag/people) with summary info (show endpoint only)
    - `id` integer
    - `first_name` string
    - `last_name` string
    - `full_name` string
    - `email` string
    - `phone` string
    - `company` string, nullable
    - `owner` string, nullable
  - `collaborators` object[]: Project collaborators (show endpoint only)
    - `id` integer
    - `collaborator_type` 'User' | 'Team'
    - `collaborator_id` integer
    - `collaborator_name` string
    - `created_at` string
  - `milestones` object[]: Summary of associated [milestones](#tag/project-milestones) (show endpoint only)
    - `id` integer
    - `name` string
    - `status` string
    - `status_color` string
    - `created_at` string
    - `updated_at` string
  - `project_milestones` object[]: Detailed milestones with nested tasks for form support (show endpoint only)
    - `id` integer
    - `name` string
    - `project_milestone_status_id` integer
    - `project_milestone_status` object
      - `id` integer
      - `name` string
      - `hex_color` string
    - `start_date` string
    - `end_date` string
    - `created_at` string
    - `updated_at` string
    - `tasks` object[]
      - `id` integer
      - `name` string
      - `due_date` string
      - `completed` boolean
      - `owner_id` integer
      - `recurrence_frequency` string
      - `owner` object
        - `id` integer
        - `full_name` string
        - `avatar_url` string
        - `avatar_file_file_name` string
      - `priority` object
        - `id` integer
        - `name` string
        - `hex_color` string
      - `category` object
        - `id` integer
        - `name` string
      - `calendar_entry_status` object: Included only when the task has a calendar entry status set
        - `id` integer
        - `name` string
        - `hex_color` string
  - `deal_ids` integer[]: IDs of [Deals](#tag/deals) to associate with this project
  - `person_ids` integer[]: IDs of [People](#tag/people) to associate with this project
  - `company_ids` integer[]: IDs of [Companies](#tag/companies) to associate with this project
  - `custom_fields` object: Custom fields for the project. See [custom fields](#tag/custom-fields) section for more info.
  - `created_at` string: Timestamp when the record was created (time zone in user's time zone).
  - `updated_at` string: Timestamp when the record was last touched (time zone in user's time zone).
  - `name` string: The name of the project. Must be unique within the account (among non-archived projects).
  - `description` string, nullable: Explanatory or descriptive text about the project
  - `status` 'open' | 'closed': The status of the project: - `open`: Active project - `closed`: Completed project
  - `start_date` string, nullable: The start date of the project (YYYY-MM-DD format)
  - `end_date` string, nullable: The end date of the project (YYYY-MM-DD format). Must be after start_date.
  - `owner_id` integer: The ID of the [user](#tag/users) who owns this project. Cannot be an external user.
  - `hex_color` string, nullable: The color associated with the project (hex code)
  - `user_ids` integer[]: IDs of [Users](#tag/users) to add as collaborators on this project
  - `team_ids` integer[]: IDs of [Teams](#tag/teams) to add as collaborators on this project
  - `project_milestones_attributes` object[]: Nested milestone attributes for creating/updating milestones inline with the project
    - `id` integer: Milestone ID (required for updates, omit for new milestones)
    - `name` string
    - `project_milestone_status_id` integer
    - `start_date` string
    - `end_date` string
    - `_destroy` boolean: Set to true to remove this milestone
  - `project_template_id` integer: Create-only. The ID of the [project template](#tag/project-templates) to seed this project from. Provided as a property of the `project` object on create. Ignored on update.
  - `source_deal_id` integer: Create-only. The ID of the [deal](#tag/deals) to source initial project data from. Provided as a property of the `project` object on create. Ignored on update.

## Other responses

- `401`: Missing, invalid, expired or revoked credentials.

---

[API](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api.md) · [All operations](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/revisions/53ebfcc83597?raw)