Customers

Create a customer

Create a new customer record.

Requires Idempotency-Key header. The brand_id is set automatically from your API key context; an explicit brand_id must be the one your key is bound to.

post/v1/customers

Request

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

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

brand_idstring uuid
customer_type'T_PERSON' | 'T_ORGANIZATION'

Type of customer record

namestring required

First name or company name

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

Created customer

Changes

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