v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Modify a customer

Update an existing customer's details.

post/v1/customers/{id}

Path parameters

idstring required

The customer ID returned at the creation stage.

Headers

x-user-secret-keystring required

Your API private/secret key. This can be found in the powerboard dashboard.

Content-Typestring required

Content-Type will always be application/json

Request body

referencestring

A manually defined reference for the modification request

first_namestring

The customer's first name

last_namestring

The customer's last name

emailstring

The customer's email

phonestring

The customer's phone

Response

200

statusinteger

{"stackTrail":"paths:/v1/customers/{id}:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "status": 200,
  "resource": {
    "type": "customer",
    "data": {
      "first_name": "Wanda",
      "_id": "5ece59dc9c49c657d60630ed",
      "created_at": "2020-05-27T12:15:25.738Z",
      "updated_at": "2020-05-27T12:35:18.111Z",
      "status": "active",
      "default_source": "5ece59dd9c49c657d60630ee",
      "payment_sources": [
        {
          "updated_at": "2020-05-27T12:35:18.110Z",
          "gateway_id": "5cbede1f151b842653e987be",
          "vault_token": "0fd20631-509e-45c7-a8f0-f1f36d6ad298",
          "card_name": "Wanda Mertz",
          "expire_month": 9,
          "expire_year": 2021,
          "card_number_last4": "4242",
          "card_number_bin": "42424242",
          "card_scheme": "visa",
          "ref_token": "cus_HM6N4T0hv9klsg",
          "status": "active",
          "created_at": "2020-05-27T12:15:25.728Z",
          "_id": "5ece59dd9c49c657d60630ee",
          "type": "card"
        }
      ],
      "_service": {
        "default_gateway_id": "5cbede1f151b842653e987be"
      }
    }
  }
}