Skip to main content
PATCH
Update a consumer

Authorizations

x-api-key
string
header
required

API key in the format sk_live_<token> (production) or sk_test_<token> (sandbox). Contact Cove to obtain your API key.

Path Parameters

id
string<uuid>
required

Resource UUID

Body

application/json

All fields optional. Include only the fields you want to change.

first_name
string
Required string length: 1 - 25
last_name
string
Required string length: 1 - 25
middle_name
string | null
Maximum string length: 25
date_of_birth
string<date>
ssn
string | null
Pattern: ^\d{3}-?\d{2}-?\d{4}$
phone
string
Pattern: ^\+\d{10,15}$
email
string<email>
address
object
external_id
string | null
Maximum string length: 255

Response

Consumer updated

id
string<uuid>
first_name
string
last_name
string
middle_name
string | null
date_of_birth
string<date>
phone
string
email
string
address
object
external_id
string | null
created_at
string<date-time>
updated_at
string<date-time>