Skip to main content
PUT
/
api
/
rest
/
customers
/
{id}
Update One Customer
curl --request PUT \
  --url https://api.upwell.com/api/rest/customers/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerRulesInput": {},
  "id": "<string>",
  "input": {}
}
'
{
  "updateCustomer": {
    "addresses": [
      {
        "city": "<string>",
        "country": "AD",
        "id": "<string>",
        "stateOrProvince": "<string>",
        "streetLine1": "<string>",
        "streetLine2": "<string>",
        "type": "ADDRESS_BOOK",
        "zipOrPostalCode": "<string>"
      }
    ],
    "balance": 123,
    "billToCustomerId": "<string>",
    "ccEmailAddresses": [
      "<string>"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "customerRule": {
      "dueOption": 123,
      "id": "<string>"
    },
    "emailAddress": "<string>",
    "id": "<string>",
    "metadata": "<unknown>",
    "name": "<string>",
    "overdueBalance": 123,
    "overdueInvoiceCount": 123,
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "updateCustomerRules": {
    "affectedRows": 123
  }
}

Headers

​
authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Path Parameters

​
id
string
required

"id" is required (enter it either in parameters or request body)

Body

application/json

Query parameters can also be provided in the request body as a JSON object

​
customerRulesInput
CustomerRulesSetInput · object

input type for updating data in table "customer_rules"

​
id
string
​
input
CustomersSetInput · object

input type for updating data in table "customers"

Response

200 - application/json

Responses for PUT /api/rest/customers/{id}

​
updateCustomer
Customers · object

columns and relationships of "customers"

​
updateCustomerRules
CustomerRulesMutationResponse · object

response of any mutation on the table "customer_rules"