Update a pipeline

PATCH {{baseUrl}}/crm/v3/pipelines/:objectType/:pipelineId?validateReferencesBeforeDelete=false&validateDealStageUsagesBeforeDelete=false

Perform a partial update of the pipeline identified by {pipelineId}. The updated pipeline will be returned in the response.

Request Params

KeyDatatypeRequiredDescription
validateReferencesBeforeDeleteboolean
validateDealStageUsagesBeforeDeleteboolean

Request Body

{"archived"=>"<boolean>", "displayOrder"=>"<integer>", "label"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;archived&quot;:&quot;\u003cboolean\u003e&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;displayOrder&quot;:&quot;\u003cinteger\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;stages&quot;:[{&quot;archived&quot;:&quot;\u003cboolean\u003e&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;displayOrder&quot;:&quot;\u003cinteger\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;metadata&quot;:{&quot;Loremb3_&quot;:&quot;\u003cstring\u003e&quot;,&quot;Duisf4&quot;:&quot;\u003cstring\u003e&quot;},&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;archivedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;writePermissions&quot;:&quot;INTERNAL_ONLY&quot;},{&quot;archived&quot;:&quot;\u003cboolean\u003e&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;displayOrder&quot;:&quot;\u003cinteger\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;metadata&quot;:{&quot;ea__63&quot;:&quot;\u003cstring\u003e&quot;},&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;archivedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;writePermissions&quot;:&quot;INTERNAL_ONLY&quot;}],&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;archivedAt&quot;:&quot;\u003cdateTime\u003e&quot;}