Skip to main content
POST
Rename a terminal

Authorizations

Authorization
string
header
required

A secret key, sk_test_... or sk_live_...; a publishable key (pk_...) on the browser routes only

Path Parameters

id
string
required
Required string length: 1 - 64

Body

application/json
label
string | null
required

The new name, 1 to 120 characters; null removes it.

Required string length: 1 - 120
Example:

"Truck 412"

Response

The terminal

object
enum<string>
required
Available options:
terminal
id
string<uuid>
required

Pass it as terminal on a payment.

Example:

"019f2c4e-7b1a-7d3e-9a10-3c5b8e2f4a61"

label
string | null
required

Your name for the terminal, such as the truck it rides in; null until you name it.

Example:

"Truck 412"

model
string | null
required
Example:

"AMS1"

serial_number
string | null
required

Printed on the back of the terminal.

Example:

"1853000123"

checked_out_to
string | null
required

Who has the terminal right now, as you named them at check-out: a tablet, a truck, a driver. null while it sits free.

Example:

"Tablet TB0011"

checked_out_at
string<date-time> | null
required

When it was checked out; null while it sits free.

Example:

"2026-10-21T12:05:00.000Z"

checked_out_by
string | null
required

Your user who did the check-out, as you sent it; null when you sent none or while the terminal sits free.

Example:

"j.doe"

livemode
boolean
required
Example:

false