Update Customer Record
Update a customer record. Include only the fields you want to change.
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
998
Body
Data pertaining to single customer. See customerData Object Model for a complete reference.
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250
"3456-7645A"
Customer username for customer portal
"myusername"
Customer password for customer portal
"mypassword"
Customer Status. Possible values:
-99
Deleted0
Inactive1
Active85
Locked (typically due to multiple failed login attempts)
1
Company name
"Sunshine LLC"
Customer first name
"John"
Customer last name
"Smith"
Customer phone number
"1234567890"
Customer email address.
320
"example@email.com"
Customer address
"777 Main St"
Additional customer address
"Apt 6"
Customer city
"Miami"
Customer State
"FL"
Customer zip code
"33000"
Customer country in ISO-3166-1 alpha 2 format
See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
"US"
The shipping address.
250
"123 Walnut St"
Additional line for shipping address.
100
"STE 900"
Shipping city.
250
"Johnson City"
Shipping state or province.
"TN"
Shipping ZIP code.
50
"37619"
Shipping address country.
"US"
Customer balance.
988.44
Timezone, in UTC offset. For example, -5 is Eastern time.
-5
Additional Custom fields in format "key":"value".
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
["email"]
Timestamp of when record was created, in UTC.
"2022-07-01 15:00:01"
Response
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
Response text for operation: 'Success' or 'Declined'.
"Success"
Code for the response. Learn more in API Response Codes.
1
Auxiliary validation used internally by payment pages and components.
null
The response data.
Was this page helpful?