Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

How the person's scanner is read. Web and API share it.

gap_ms
integer
required
Required range: 10 <= x <= 80
min_length
integer
required
Required range: 3 <= x <= 12
screen_reader
boolean
required
prefix
string | null
Maximum string length: 8
gs_replacement
string | null
Maximum string length: 4
tones
boolean | null

Response

ScannerPreferencesResource

data
ScannerPreferencesResource · object
required