Skip to main content
PATCH
/
consumers
/
{id}
Update a consumer
curl --request PATCH \
  --url https://vvdufluovypptsnkihyv.supabase.co/functions/v1/consumers/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "phone": "+15559876543",
  "address": {
    "street": "456 Oak Ave",
    "city": "Austin",
    "state": "TX",
    "postal_code": "73301"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "first_name": "<string>",
  "last_name": "<string>",
  "middle_name": "<string>",
  "date_of_birth": "2023-12-25",
  "phone": "<string>",
  "email": "<string>",
  "address": {
    "street": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "US"
  },
  "external_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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>