Skip to main content
PUT
Update One Customer By Source System Id
Updates by external key: send sourceSystem + sourceSystemId inside input to update without the Upwell id. See Idempotency & retries.

Authorizations

Authorization
string
header
required

Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.

Query Parameters

sourceSystem
string

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

sourceSystemId
string

"sourceSystemId" 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 | null

input type for updating data in table "customer_rules"

input
CustomersSetInput · object | null

input type for updating data in table "customers"

sourceSystem
string
sourceSystemId
string

Response

Responses for PUT /api/rest/customers

updateCustomer
CustomersMutationResponse · object | null

response of any mutation on the table "customers"

updateCustomerRules
CustomerRulesMutationResponse · object | null

response of any mutation on the table "customer_rules"