Skip to content

Update Terminals

Updates the specified terminal(s).

Verb PATCH
Endpoint {base-url}/terminals
Max Page Size N/A

Request Body

{
  "body": [
    {
      "id": 121,
      "chargeKeyId": 180,
      "terminalId": "1196023",
      "addedAt": "2015-08-12T15:32:30.643",
      "number": 9690,
      "isAvailable": false,
      "isActive": true,
      "machineId": 9690,
      "assignedAt": "2015-08-12T15:32:30.643",
      "deactivatedAt": null
    }
  ]
}

Note

All changes in this request are atomic. If any item fails, the entire batch is rolled back and no changes are made.

Returns

On Success

204 - No Content

Response Body

// 204 - No Content

On Error

HTTP Code Error Code Definition
422 VALIDATION_ERROR A required field is missing or invalid (e.g. terminalId exceeds 50 characters, number is less than 1, addedAt is in the future).
403 DATA_ACCESS_VIOLATION One or more of the terminals, or a charge key you are reassigning, belongs to an organization you do not have access to.
404 MISSING_RECORD One or more of the terminals, or a charge key you are reassigning, does not exist.

Note

machineId is immutable on update: a terminal cannot be moved between machines. A machineId supplied in an update body is ignored; the terminal keeps the machine it was created with. To move a terminal to a different machine, delete it and create a new one on the target machine.