LIlightspeed
ID Cards

Update the name of an ID Card's consumer

Changed on

Sets the first name, the last name, or both, of the consumer linked to an ID card, on this business's consumer record. Only firstName and lastName are used and other fields are ignored. A missing or null field is left unchanged; at least one of them must have a value.

Only placeholder consumers, whose email address ends in @ikentoo.net, such as the consumers created by Create ID Cards, can be updated. If the card is linked to any other consumer, the request is rejected with a 409 and nothing is changed. The consumer ID and the email address never change.

patch/id-cards/v1/business-locations/{businessLocationId}/cards/{cardId}/consumer

Request

  • Base URL
    https://api.trial.lsk.lightspeed.app
  • URL
    https://api.trial.lsk.lightspeed.app/id-cards/v1/business-locations/{businessLocationId}/cards/{cardId}/consumer
  • Auth
    OAuth 2
    Authorization code: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth
    Token URL: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token scopes: id-cards

Path parameters

businessLocationIdinteger required

The unique identifier for the business location.

cardIdinteger required

The unique identifier for the ID card.

Request body

firstNamestring

The consumer's first name. Leave out or send null to keep it unchanged.

lastNamestring

The consumer's last name. Leave out or send null to keep it unchanged.

Example request

{
  "firstName": "Maria",
  "lastName": "Rossi"
}

Response

The consumer's name was updated.

cardIdinteger

The unique identifier for the ID card.

consumerIdinteger

The unique identifier for the consumer linked to the card.

firstNamestring

The consumer's first name.

lastNamestring

The consumer's last name.

Example response

{
  "cardId": 98765,
  "consumerId": 13579,
  "firstName": "Maria",
  "lastName": "Rossi"
}

Changes