Update the name of an ID Card's consumer | Lightspeed Restaurant K-Series API documentation

Update the name of an ID Card's consumer Beta

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://api-docs.lsk.lightspeed.app/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Lightspeed Restaurant K-Series MCP server": {
    "url": "https://api-docs.lsk.lightspeed.app/mcp"
  }
}

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

O auth2

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.

Path parameters

businessLocationId integer(int64) Required

The unique identifier for the business location.
cardId integer(int64) Required

The unique identifier for the ID card.

application/json

Body Required

firstName string

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

Maximum length is 128. Format should match the following pattern: .*[^\s\p{Z}\p{C}].*.
lastName string

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

Maximum length is 128. Format should match the following pattern: .*[^\s\p{Z}\p{C}].*.

Responses

200 application/json

The consumer's name was updated.
Hide response attributes Show response attributes object
- cardId integer(int64)
  
  The unique identifier for the ID card.
- consumerId integer(int64)
  
  The unique identifier for the consumer linked to the card.
- firstName string
  
  The consumer's first name.
- lastName string
  
  The consumer's last name.
400

Invalid body, such as a blank or too long name, a name made only of spaces or invisible characters, or no firstName or lastName value at all.
403

The caller has no access to this business location.
404

The ID card was not found at this business location (for example because it belongs to another business location), is revoked, is not linked to a consumer, or is linked to a placeholder consumer that has no record at this business.
409

The card is linked to a consumer whose email address does not end in @ikentoo.net.

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

curl \
 --request PATCH 'https://api.trial.lsk.lightspeed.app/id-cards/v1/business-locations/{businessLocationId}/cards/{cardId}/consumer' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "firstName": "Maria",
  "lastName": "Rossi"
}'

Request examples

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

Response examples (200)

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