Update a Pipeline

PUT

https://api.close.com/api/v1/pipeline/:id/

PUT

/api/v1/pipeline/:id/

curl -X PUT https://api.close.com/api/v1/pipeline/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "name": "Updated Name",
  "statuses": [
    {
      "id": "stat_3mmBOyMmaG8yc4DmAPp9WmgbjhVctVLlnd9gmvWxBe2"
    },
    {
      "id": "stat_IOCtLYbAclJ8XAcb3yLUhQA3zlmjtXz8JMBLyXnNMF8"
    },
    {
      "id": "stat_3PB2sedHBCjwuBImAEwgHOo858f2j41lpROkcl51Fzp"
    }
  ]
}'

{
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2019-11-04T11:04:13.014979",
  "date_updated": "2019-11-15T14:12:13.051542",
  "id": "pipe_6gV01if4wo7r2YTVQDWP2j",
  "name": "Updated Name",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "statuses": [
    {
      "id": "stat_3mmBOyMmaG8yc4DmAPp9WmgbjhVctVLlnd9gmvWxBe2",
      "label": "Lost",
      "type": "lost"
    },
    {
      "id": "stat_IOCtLYbAclJ8XAcb3yLUhQA3zlmjtXz8JMBLyXnNMF8",
      "label": "Won",
      "type": "won"
    },
    {
      "id": "stat_3PB2sedHBCjwuBImAEwgHOo858f2j41lpROkcl51Fzp",
      "label": "Active",
      "type": "active"
    }
  ],
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

You can use this endpoint to:

Rename a Pipeline.
Reorder Opportunity Statuses within a Pipeline.
Move an Opportunity Status from a different Pipeline into this one.
- To do so, include {"id": "id_of_the_status_from_another_pipeline"} in the statuses list.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects an object.

namestringOptionalDefaults to

statuseslist of objects or nullOptional

Opportunity Statuses of this Pipeline, in the desired order.

Response

Successful response

created_bystring or null

date_createddatetime

date_updateddatetime

idstring

namestring

organization_idstring

statuseslist of objects

updated_bystring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error