Customers

Update a customer

Update one customer. Send only the fields to change; the response is the updated customer.

Requires an Idempotency-Key header.

patch/v1/customers/{customerId}

Request

  • Base URL: https://api.workwing.io
  • URL: https://api.workwing.io/v1/customers/{customerId}
  • Auth: HTTP bearer

Path parameters

customerIdstring uuid required

The customer's id

Query parameters

selectstring

Comma-separated columns to return. Supports embedded resources: *,customer:customers(name,email)

Headers

Idempotency-Keystring required

Unique per write, 1-256 printable ASCII characters. Retrying with the same key and the same request replays the original response for 24 hours. See Idempotency.

Request body

customer_type'T_PERSON' | 'T_ORGANIZATION'

Type of customer record

namestring
last_namestring
emailstring email
phonestring
contact_first_namestring
contact_last_namestring
contact_emailstring email
contact_phonestring
address_line1string
address_line2string
citystring
statestring
postal_codestring
countrystring
external_crm_idstring
external_crm_typestring

Response

The updated customer

Changes

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