Projects

Archive project

Archives the project. Archived projects are excluded from default list queries. Also accepts PATCH.

put/projects/{id}/archive

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/projects/{id}/archive
  • 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

Path parameters

idinteger required

Project ID

Response

Successful Response

idinteger

Unique identifier

archived_atstring nullable

Timestamp when the project was archived, or null if active

is_sampleboolean

Whether this project was created from sample data seeded for the account

is_archivedboolean

Whether the project is currently archived

is_activeboolean

Whether the project is currently active (not archived)

created_by_user_idinteger nullable

The ID of the user who created this project

deal_idsinteger[]

IDs of Deals to associate with this project

person_idsinteger[]

IDs of People to associate with this project

company_idsinteger[]

IDs of Companies to associate with this project

custom_fieldsobject

Custom fields for the project. See custom fields section for more info.

created_atstring

Timestamp when the record was created (time zone in user's time zone).

updated_atstring

Timestamp when the record was last touched (time zone in user's time zone).

namestring

The name of the project. Must be unique within the account (among non-archived projects).

descriptionstring nullable

Explanatory or descriptive text about the project

status'open' | 'closed'

The status of the project:

  • open: Active project
  • closed: Completed project
start_datestring nullable

The start date of the project (YYYY-MM-DD format)

end_datestring nullable

The end date of the project (YYYY-MM-DD format). Must be after start_date.

owner_idinteger

The ID of the user who owns this project. Cannot be an external user.

hex_colorstring nullable

The color associated with the project (hex code)

user_idsinteger[]

IDs of Users to add as collaborators on this project

team_idsinteger[]

IDs of Teams to add as collaborators on this project

project_template_idinteger

Create-only. The ID of the project template to seed this project from. Provided as a property of the project object on create. Ignored on update.

source_deal_idinteger

Create-only. The ID of the deal to source initial project data from. Provided as a property of the project object on create. Ignored on update.

Example response

{
  "id": 91,
  "archived_at": "2025-03-01 10:00:00",
  "is_active": true,
  "created_by_user_id": 13473,
  "owner": {
    "id": 13,
    "full_name": "Sam Okafor"
  },
  "created_by_user": {
    "id": 27,
    "full_name": "Priya Natarajan"
  },
  "counts": {
    "deals": 2,
    "people": 3,
    "companies": 1,
    "milestones": 4
  },
  "stats": {
    "open_deals_value": 24000,
    "won_deals_value": 12000
  },
  "deals": [
    {
      "id": 4521,
      "name": "Acme Corporation - Q4 renewal"
    }
  ],
  "companies": [
    {
      "id": 3310,
      "name": "Acme Corporation"
    }
  ],
  "people": [
    {
      "id": 8802,
      "first_name": "Jane",
      "last_name": "Rivera"
    },
    {
      "id": 8815,
      "first_name": "Marcus",
      "last_name": "Chen"
    }
  ],
  "collaborators": [
    {
      "id": 27,
      "first_name": "Priya",
      "last_name": "Natarajan"
    }
  ],
  "milestones": [
    {
      "id": 88,
      "name": "Discovery complete",
      "due_date": "2026-09-30"
    }
  ],
  "project_milestones": [
    {
      "id": 88,
      "name": "Discovery complete",
      "status": "in_progress"
    }
  ],
  "deal_ids": [
    1,
    2,
    3
  ],
  "person_ids": [
    100,
    200
  ],
  "company_ids": [
    10,
    20
  ],
  "custom_fields": {
    "custom_label_90": "text val",
    "custom_label_5": 42
  },
  "created_at": "2026-09-01 14:22:07",
  "updated_at": "2026-09-01 14:22:07",
  "name": "Acme onboarding",
  "description": "Complete redesign of the company website with new branding",
  "status": "open",
  "start_date": "2026-09-15",
  "end_date": "2026-12-15",
  "owner_id": 13473,
  "hex_color": "#4A90D9",
  "user_ids": [
    5,
    6
  ],
  "team_ids": [
    1
  ],
  "project_milestones_attributes": [
    {
      "name": "Phase 1 - Discovery",
      "project_milestone_status_id": 1,
      "start_date": "2025-01-15",
      "end_date": "2025-02-28"
    }
  ],
  "project_template_id": 6,
  "source_deal_id": 42
}

Changes

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