Update customer data partially
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Update customer data partially

  • Dark
    Light
  • PDF

Article summary

Patch
/customers/{id}/

Operation is used to update specific fields in existing customer data. Available from product version 3.2.2.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of customer to update

Body parameters

Customer attributes and values to be updated

object
address
integer Required

Customer Apartment id

addressAlt
integer

Customer Apartment id

billingName
string

Customer billing name

businessId
string

Customer bussiness id

email
string

Customer email

mobilePhone
string

Customer mobile phone number name

name
string

Customer name

number
string

Customer number

phone
string

Customer phone number

smsProhibited
boolean

Sending sms is prohibited to customer

telefax
string

Customer fax number

type
integer

Customer type id

Responses
200

Object was updated successfully

object
address
integer

Customer Apartment id

addressAlt
integer

Customer Apartment id

billingName
string

Customer billing name

businessId
string

Customer bussiness id

createdBy
string

creator

createdTs
string (date-time)

Creation date and time

email
string

Customer email

id
integer

Primary key

mobilePhone
string

Customer mobile phone number name

name
string

Customer name

number
string

Customer number

phone
string

Customer phone number

smsProhibited
boolean

Sending sms is prohibited to customer

telefax
string

Customer fax number

type
integer

Customer type id

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object
details
string

Detailed description of error


Was this article helpful?