HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

Update a contact channel

put
https://{domain_prefix}.retail.lightspeed.app/api/2026-07/customers//contact_channels/

Updates a contact channel of the specified customer. The type of a channel that is currently the default cannot be changed.

🔒 Requires: customers:write scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the customer.

string
required

The identifier of the contact channel, as returned in the id field of a contact channel.

Body Params
string | null

Optional free-text note. Maximum 4000 characters.

int32
≥ 0
Defaults to 0

Position of the channel in ordered listings.

string
enum
required

The kind of contact channel.

string
required
length between 1 and 2048

The contact value. Maximum 2048 characters, or 255 characters for the email, phone, fax, mobile and website types. Must be a valid email address when type is email.

Responses

401

Unauthorized

403

Forbidden - insufficient permissions

Updated about 2 hours ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?