Customers

Update customer

put/customers/{id}

Request

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

Customer ID

Request body

Example request

{
  "customer": {
    "health_score": "middle",
    "health_score_description": "Very positive engagement recently - relationship is improving!"
  }
}

Response

Successful Response

idinteger

Unique identifier

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).

company_idinteger

The ID of the company associated to this customer

days_in_healthinteger

How long the customer relationship has had it's current health score

health_score'low' | 'middle' | 'high' | 'null' nullable

The health of the relationship with this customer

health_score_descriptionstring nullable

Explanation or notes for the health score

Example response

{
  "id": 1,
  "created_at": "2026-09-01 14:22:07",
  "updated_at": "2026-09-01 14:22:07",
  "company_id": 1,
  "days_in_health": 36,
  "health_score": "middle",
  "health_score_description": "Very positive engagement recently - relationship is improving!"
}

Changes

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