Update Customer by ID

patch https://qa2.revelup.com/resources/Customer/{CustomerId}/

Updates a single Customer object

Path Params

CustomerId

int64

required

ID of Customer to update

Body Params

Customer data that needs to be changed

accept_checks

boolean

Defaults to false

Flag. If set to True will allow checks to be accepted on the POS for this customer.

account_balance

integer

Deprecated - HouseAccount resource used instead.

account_limit

integer

Deprecated - HouseAccount resource used instead.

active

boolean

Flag. If set to True, the customer is visible on the POS and Management Console.

address

string

Deprecated - CustomerAddress resource used instead.

addresses

array of objects

Array that lists all valid addresses linked to this customer. The address with "primary_billing": true is considered the default.

addresses

birth_date

date-time

ISO8601 timestamp used to specify the customer's birthdate. Visible on the POS.

cc_exp

string

length ≤ 20

Unused field. Intended to store the customer's credit card expiry date.

cc_first_name

string

length ≤ 200

Unused field. Intended to store the first name on the customer's credit card.

cc_last_name

string

length ≤ 200

Unused field. Intended to store the last name on the customer's credit card.

cc_last_4_digits

string

length ≤ 4

Unused field. Intended to store the last 4 digits of the customer's credit card number.

city

string

Deprecated - CustomerAddress resource used instead.

company_name

string

length ≤ 100

Field used to store the name of the company the customer is associated with. Required if "type" is set to 1.

contract_expiration

date-time

ISO8601 timestamp used to specify when the customer's contract expires. If the "Contract Expiration" setting is enabled, alerts will be thrown on the POS when the current date passes this timestamp.

created_by

uri

required

URI of the User API object that created this resource.

created_date

date-time

ISO8601 timestamp of the time the resource was created.

customer_groups

array of uris

List of CustomerGroup API objects that this customer is linked to.

customer_groups

deleted

boolean

Flag. If set to True, the Customer resource is deactivated and becomes inaccessible via API. Irreversible.

discount

float

Decimal field. No longer in use anywhere in the code.

string

Field used to define the e-mail address of the user. Can be used as a primary identifier via an internal system setting.

email_opt_in

boolean

Flag. If set to True, the customer consents to marketing e-mails. Only applicable if customer privacy settings are enabled via an internal system setting.

exp_date

string

Localized date time field. Unused in the system.

expensify_account

string

length ≤ 255

Expensify account login token. No longer used.

first_name

string

length ≤ 200

Field used to specify the customer's first name. Used for customer lookup on the POS.

gender

integer

Defaults to 0

Customer gender.

gift_card_numbers

array of strings

List of gift card code numbers associated with this customer.

gift_card_numbers

is_visitor

boolean

Flag. If set to True, the customer is marked as a visitor. Part of the deprecated visitor tracking feature.

last_name

string

length ≤ 200

Field used to specify the customer's last name. Used for customer lookup on the POS.

lic_number

string

length ≤ 200

Customer's vehicle license plate number. Not used for any tracking, but displayed on the POS.

loyalty_number

string

length ≤ 255

Reference number for an external loyalty integration

loyalty_ref_id

string

length ≤ 255

Reference ID for an external loyalty integration.

notes

string

Free-text field used to add notes about the customer. Displayed on the POS.

ok_to_email

boolean

Defaults to true

Flag. If set to True, the customer e-mail address can be used. Only used as a reference field during CRM export, does not actually represent customer consent like the "email_opt_in" field does.

past_due

float

Decimal field. No longer in use anywhere in the code.

phone_number

string

length ≤ 20

Field used to specify the customer's phone number. Can be used as a primary identifier via an internal system setting.

phone_opt_in

boolean

Flag. If set to True, the customer consents to marketing phone calls & messages. Only applicable if customer privacy settings are enabled via an internal system setting.

string

length ≤ 255

Customer PIN - used for customers to be able to log in to Revel Kiosk stations and redeem their rewards.

post_opt_in

boolean

Flag. If set to True, the customer consents to marketing via physical mail. Only applicable if customer privacy settings are enabled via an internal system setting.

ref_number

string

length ≤ 200

Free-form text field. Can be used to store any information and used as a primary identifier via an internal system setting.

reward_card_numbers

array of strings

List of loyalty card codes associated with this customer.

reward_card_numbers

source

integer

Placeholder field that stores the source of customer changes. Used temporarily to create a change log entry.

state

string

Deprecated - CustomerAddress resource used instead.

tax_exempt

boolean

Defaults to false

Flag. Does not do anything in Revel, but can be used for third party integrations.

tax_location

string

length ≤ 255

Free-form text field - visible in CRM export file, but does not do anything in Revel.

third_party_id

integer

Integer field - visible in CRM export file, but does not do anything in Revel.

title

string

length ≤ 255

Customer's title (e.g. Mr, Mrs, Ms, Dr)

total_purchases

integer

Defaults to 0

Deprecated - see CustomerHistory resource instead.

total_visits

integer

Defaults to 0

Deprecated - see CustomerHistory resource instead.

track_as_company

boolean

Defaults to false

Flag. If set to True, the customer is regarded as a point of contact for his company. Changes the way the customer is presented on the POS.

type

integer

Defaults to 0

updated_by

uri

required

URI of the User API object that last made changes to this resource.

updated_date

date-time

ISO8601 timestamp of the last time the resource was updated.

uuid

Resource UUID - must be unique.

vehicles

array of objects

List of CustomerVehicle resources associated with this customer.

vehicles

version_date

date-time

ISO8601 timestamp of the last time the resource was updated by Revel. Separate from "updated_by" in case of API changes.

zipcode

string

Deprecated - CustomerAddress resource used instead.

Responses

Response body

object

accept_checks

boolean

Defaults to false

Flag. If set to True will allow checks to be accepted on the POS for this customer.

account_balance

integer

Deprecated - HouseAccount resource used instead.

account_limit

integer

Deprecated - HouseAccount resource used instead.

active

boolean

Flag. If set to True, the customer is visible on the POS and Management Console.

address

string

Deprecated - CustomerAddress resource used instead.

addresses

array of objects

Array that lists all valid addresses linked to this customer. The address with "primary_billing": true is considered the default.

addresses

object

active

boolean

Defaults to true

Flag. If set to True, the address is visible and can be used for delivery.

address_type

integer

deprecated

Deprecated field - see "primary_billing" and "primary_shipping" instead.

city

string

length ≤ 100

Field used to specify the customer's city.

company_name

string

Field used to specify the name of the customer's associated company.

country

string

required

length ≤ 2

Field used to specify the customer's country. Expects a ISO 3166-2 country code.

created_date

date-time

ISO8601 timestamp of the time the resource was created.

delivery_instructions

string

Text field for additional information about this CustomerAddress.

string

Field used to specify the contact e-mail for this address.

int64

Id of this CustomerAddress object.

name

string

length ≤ 60

Name of this delivery address.

phone_number

string

length ≤ 20

Field used to specify the contact number for this address.

primary_billing

boolean

Defaults to false

Flag. If set to True, this address will be used by default for all invoices.

primary_shipping

boolean

Defaults to false

Flag. If set to True, this address will be used by default for all shipping/delivery orders.

resources_uri

uri

URI of CustomerAddress object.

state

string

length ≤ 50

Field used to specify the customer's state.

street_1

string

length ≤ 280

Field used to specify the first line of the customer'saddress.

street_2

string

length ≤ 280

Field used to specify the second line of the customer'saddress. Not validated - can contain additional address info such as door number,floor, etc.

updated_date

date-time

ISO8601 timestamp of the time the resource was updated.

uuid

UUID of this Package resource.

zipcode

string

length ≤ 20

Field used to specify the customer's postal code.

birth_date

date-time

ISO8601 timestamp used to specify the customer's birthdate. Visible on the POS.

cc_exp

string

length ≤ 20

Unused field. Intended to store the customer's credit card expiry date.

cc_first_name

string

length ≤ 200

Unused field. Intended to store the first name on the customer's credit card.

cc_last_name

string

length ≤ 200

Unused field. Intended to store the last name on the customer's credit card.

cc_last_4_digits

string

length ≤ 4

Unused field. Intended to store the last 4 digits of the customer's credit card number.

city

string

Deprecated - CustomerAddress resource used instead.

company_name

string

length ≤ 100

Field used to store the name of the company the customer is associated with. Required if "type" is set to 1.

contract_expiration

date-time

ISO8601 timestamp used to specify when the customer's contract expires. If the "Contract Expiration" setting is enabled, alerts will be thrown on the POS when the current date passes this timestamp.

created_by

uri

required

URI of the User API object that created this resource.

created_date

date-time

ISO8601 timestamp of the time the resource was created.

customer_groups

array of uris

List of CustomerGroup API objects that this customer is linked to.

customer_groups

deleted

boolean

Flag. If set to True, the Customer resource is deactivated and becomes inaccessible via API. Irreversible.

discount

float

Decimal field. No longer in use anywhere in the code.

string

Field used to define the e-mail address of the user. Can be used as a primary identifier via an internal system setting.

email_opt_in

boolean

Flag. If set to True, the customer consents to marketing e-mails. Only applicable if customer privacy settings are enabled via an internal system setting.

exp_date

string

Localized date time field. Unused in the system.

expensify_account

string

length ≤ 255

Expensify account login token. No longer used.

first_name

string

length ≤ 200

Field used to specify the customer's first name. Used for customer lookup on the POS.

gender

integer

Defaults to 0

Customer gender.

1 2

gift_card_numbers

array of strings

List of gift card code numbers associated with this customer.

gift_card_numbers

int64

The ID of this resource. Populated automatically on resource creation.

image

string

URL of the customer's image. No longer used and could only be added via internal image picker tool.

is_visitor

boolean

Flag. If set to True, the customer is marked as a visitor. Part of the deprecated visitor tracking feature.

last_name

string

length ≤ 200

Field used to specify the customer's last name. Used for customer lookup on the POS.

lic_number

string

length ≤ 200

Customer's vehicle license plate number. Not used for any tracking, but displayed on the POS.

loyalty_number

string

length ≤ 255

Reference number for an external loyalty integration

loyalty_ref_id

string

length ≤ 255

Reference ID for an external loyalty integration.

notes

string

Free-text field used to add notes about the customer. Displayed on the POS.

ok_to_email

boolean

Defaults to true

Flag. If set to True, the customer e-mail address can be used. Only used as a reference field during CRM export, does not actually represent customer consent like the "email_opt_in" field does.

past_due

float

Decimal field. No longer in use anywhere in the code.

phone_number

string

length ≤ 20

Field used to specify the customer's phone number. Can be used as a primary identifier via an internal system setting.

phone_opt_in

boolean

Flag. If set to True, the customer consents to marketing phone calls & messages. Only applicable if customer privacy settings are enabled via an internal system setting.

picture

string

No longer used - contains URL that points to an image.

string

length ≤ 255

Customer PIN - used for customers to be able to log in to Revel Kiosk stations and redeem their rewards.

post_opt_in

boolean

Flag. If set to True, the customer consents to marketing via physical mail. Only applicable if customer privacy settings are enabled via an internal system setting.

ref_number

string

length ≤ 200

Free-form text field. Can be used to store any information and used as a primary identifier via an internal system setting.

resource_uri

string

URI of this Customer API object. Populated automatically when the resource is created.

reward_card_numbers

array of strings

List of loyalty card codes associated with this customer.

reward_card_numbers

source

integer

Placeholder field that stores the source of customer changes. Used temporarily to create a change log entry.

1 2 3

state

string

Deprecated - CustomerAddress resource used instead.

tax_exempt

boolean

Defaults to false

Flag. Does not do anything in Revel, but can be used for third party integrations.

tax_location

string

length ≤ 255

Free-form text field - visible in CRM export file, but does not do anything in Revel.

third_party_id

integer

Integer field - visible in CRM export file, but does not do anything in Revel.

title

string

length ≤ 255

Customer's title (e.g. Mr, Mrs, Ms, Dr)

total_purchases

integer

Defaults to 0

Deprecated - see CustomerHistory resource instead.

total_visits

integer

Defaults to 0

Deprecated - see CustomerHistory resource instead.

track_as_company

boolean

Defaults to false

Flag. If set to True, the customer is regarded as a point of contact for his company. Changes the way the customer is presented on the POS.

type

integer

Defaults to 0

1

updated_by

uri

required

URI of the User API object that last made changes to this resource.

updated_date

date-time

ISO8601 timestamp of the last time the resource was updated.

uuid

Resource UUID - must be unique.

vehicles

array of objects

List of CustomerVehicle resources associated with this customer.

vehicles

object

active

boolean

created_date

date-time

int64

manufacturer

string

model

string

odometer

int64

owner

string

plate

string

resource_uri

uri

state

string

updated_date

date-time

uuid

vin

string

year

int64

version_date

date-time

ISO8601 timestamp of the last time the resource was updated by Revel. Separate from "updated_by" in case of API changes.

zipcode

string

Deprecated - CustomerAddress resource used instead.

301

Invalid request URL - make sure that the URL ends with a trailing slash.

400

Invalid input - please run the request body through a JSON validator.

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

404

Customer not found

445

Message: Integrity Error - an invalid value was provided for one of the fields.

xxxxxxxxxx
curl --request PATCH \
     --url https://qa2.revelup.com/resources/Customer/CustomerId/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "accept_checks": false,
  "gender": 0,
  "ok_to_email": true,
  "tax_exempt": false,
  "total_purchases": 0,
  "total_visits": 0,
  "track_as_company": false,
  "type": 0
}
'

201Resource successfully created.