Skip to main content
PUT
/
v1
/
customers
/
{customerId}
Update Customer
curl --request PUT \
  --url https://{cluster}.voucherify.io/v1/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "name": "Alice McDonald",
  "email": "alice.mdconald@email.com",
  "description": "Updating customer data",
  "phone": "+1 (132) 222-2222",
  "address": {
    "city": "New York",
    "country": "United States",
    "line_1": "123 Main St.",
    "line_2": "APT 3 BLG 4",
    "postal_code": "10001",
    "state": "NY"
  },
  "metadata": {
    "lang": "en",
    "test": true
  },
  "birthdate": "2022-01-01",
  "birthday": "2022-01-02"
}'
{
  "id": "cust_T849EgzNVVmn5icJ2FAkT2rO",
  "source_id": "alice@morgan.com",
  "name": "Alice McDonald",
  "description": "Updating customer data",
  "email": "alice.mdconald@email.com",
  "phone": "+1 (132) 222-2222",
  "birthday": "2022-01-02",
  "birthdate": "2022-01-01",
  "address": {
    "city": "New York",
    "state": "NY",
    "line_1": "123 Main St.",
    "line_2": "APT 3 BLG 4",
    "country": "United States",
    "postal_code": "10001"
  },
  "summary": {
    "redemptions": {
      "total_redeemed": 2,
      "total_failed": 0,
      "total_succeeded": 2,
      "total_rolled_back": 0,
      "total_rollback_failed": 0,
      "total_rollback_succeeded": 0,
      "gift": {
        "redeemed_amount": 0,
        "amount_to_go": 0
      },
      "loyalty_card": {
        "redeemed_points": 0,
        "points_to_go": 4428
      }
    },
    "orders": {
      "total_amount": 203900,
      "total_count": 2,
      "average_amount": 101950,
      "last_order_amount": 3900,
      "last_order_date": "2022-07-26T14:59:52.814Z"
    }
  },
  "loyalty": {
    "points": 3403,
    "referred_customers": 0,
    "campaigns": {
      "Summer Campaign": {
        "points": 0,
        "referred_customers": 0
      },
      "Spring Campaign": {
        "points": 50,
        "referred_customers": 0
      },
      "Fall Campaign": {
        "points": 50,
        "referred_customers": 0
      },
      "Winter Campaign": {
        "points": 3303,
        "referred_customers": 0
      }
    }
  },
  "referrals": {
    "total": 0,
    "campaigns": []
  },
  "metadata": {
    "lang": "en",
    "test": true
  },
  "system_metadata": {},
  "created_at": "2022-02-07T08:28:23.644Z",
  "updated_at": "2022-08-31T09:58:30.475Z",
  "object": "customer"
}

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

Path Parameters

customerId
string
required
Example:

Body

application/json
name
string
description
string
email
string
phone
string
birthday
string<date>
birthdate
string<date>
address
object | null
metadata
object

Response

summary
object
required
loyalty
object
required
referrals
object
required
object
enum<string>
default:customer
required
Available options:
customer
id
string
source_id
string
system_metadata
object
created_at
string<date-time>
Example:
updated_at
string<date-time>
Example:
assets
object
name
string
description
string
email
string
phone
string
birthday
string<date>
birthdate
string<date>
address
object | null
metadata
object