PUT
/
Customer
/
{customerId}
curl --request PUT \
  --url https://api-sandbox.payabli.com/api/Customer/{customerId} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "customerNumber": "3456-7645A",
  "customerUsername": "myusername",
  "customerPsw": "mypassword",
  "customerStatus": 1,
  "company": "Sunshine LLC",
  "firstname": "John",
  "lastname": "Smith",
  "phone": "1234567890",
  "email": "example@email.com",
  "address": "777 Main St",
  "address1": "Apt 6",
  "city": "Miami",
  "state": "FL",
  "zip": "33000",
  "country": "US",
  "shippingAddress": "123 Walnut St",
  "shippingAddress1": "STE 900",
  "shippingCity": "Johnson City",
  "shippingState": "TN",
  "shippingZip": "37619",
  "shippingCountry": "US",
  "balance": 988.44,
  "timeZone": -5,
  "additionalFields": {},
  "identifierFields": [
    "email"
  ],
  "createdAt": "2022-07-01 15:00:01"
}'
{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": " ",
  "pageIdentifier": null
}

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
customerId
integer
required

Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.

Example:

998

Body

CustomerData object to update.

Data pertaining to single customer. See customerData Object Model for a complete reference.

​
customerNumber
string | null

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Maximum length: 250
Example:

"3456-7645A"

​
customerUsername
string | null

Customer username for customer portal

Example:

"myusername"

​
customerPsw
string | null

Customer password for customer portal

Example:

"mypassword"

​
customerStatus
integer | null

Customer Status. Possible values:

  • -99 Deleted
  • 0 Inactive
  • 1 Active
  • 85 Locked (typically due to multiple failed login attempts)
Example:

1

​
company
string | null

Company name

Example:

"Sunshine LLC"

​
firstname
string | null

Customer first name

Example:

"John"

​
lastname
string | null

Customer last name

Example:

"Smith"

​
phone
string | null

Customer phone number

Example:

"1234567890"

​
email
string | null

Customer email address.

Maximum length: 320
Example:

"example@email.com"

​
address
string | null

Customer address

Example:

"777 Main St"

​
address1
string | null

Additional customer address

Example:

"Apt 6"

​
city
string | null

Customer city

Example:

"Miami"

​
state
string | null

Customer State

Example:

"FL"

​
zip
string | null

Customer zip code

Example:

"33000"

​
country
string | null

Customer country in ISO-3166-1 alpha 2 format
See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.

Example:

"US"

​
shippingAddress
string | null

The shipping address.

Maximum length: 250
Example:

"123 Walnut St"

​
shippingAddress1
string | null

Additional line for shipping address.

Maximum length: 100
Example:

"STE 900"

​
shippingCity
string | null

Shipping city.

Maximum length: 250
Example:

"Johnson City"

​
shippingState
string | null

Shipping state or province.

Example:

"TN"

​
shippingZip
string | null

Shipping ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: "37615-1234" or "37615".

Maximum length: 50
Example:

"37619"

​
shippingCountry
string | null

Shipping address country.

Example:

"US"

​
balance
number | null

Customer balance.

Example:

988.44

​
timeZone
integer | null
default:0

Timezone, in UTC offset. For example, -5 is Eastern time.

Example:

-5

​
additionalFields
object | null

Additional Custom fields in format "key":"value".

​
identifierFields
(string | null)[] | null

List of fields acting as customer identifiers, to be used instead of CustomerNumber.

Example:
["email"]
​
createdAt
string

Timestamp of when record was created, in UTC.

Example:

"2022-07-01 15:00:01"

Response

200 - application/json
Success
​
isSuccess
boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

​
responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

​
responseCode
integer | null

Code for the response. Learn more in API Response Codes.

Example:

1

​
pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

​
responseData

The response data.

Was this page helpful?