Customers

Update a customer

Update customer profile fields or lifecycle status. Send at least one field; use null to clear nullable fields. Every request updates updated_at and publishes a customer.updated event, so retrying can publish duplicate events.

patch/customers/{id}

Request

  • Base URL: https://api.kirimdev.com/v1
  • URL: https://api.kirimdev.com/v1/customers/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Public Kirimdev end-customer ID.

Example:cus_01HXYZABCDEFGHJKMNPQRSTVWX

Request body

namestring
emailstring email nullable
metadataobject nullable
status'pending' | 'active' | 'suspended'

Response

Updated customer

request_idstring required

Unique request identifier to include when contacting support.

Example response

{
  "data": {
    "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
  },
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

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