Add Device Group

Add a new device group. Once the new device group is added, you can begin to add existing devices to the group.

SecurityApiKeyAuth
Request
Request Body schema:
id
required
string

Unique identifier for the device group

name
required
string

Name of the device group

deviceCount
required
integer >= 0

Total number of devices in the group

status
required
string

Current status of the device group

clientId
required
string

Identifier of the client to which the device group belongs

industry
string

Industry type of the device group

posMode
string

POS mode used by the device group

hasZipCodePrompt
boolean

Whether the device group has zip code prompts active.

hasCvvPrompt
boolean

Whether the device group has CVV prompts active

hasTipLine
boolean

Whether devices in the device group produce a receipt.

hasTipRecommendation
boolean

Whether receipts from devices in the device group recommend tip or gratuity amounts.

Responses
201

Created

400

Bad Request

401

Unauthorized access

403

Access forbidden

404

Resource was not found

409

Conflict.

429

Too Many Requests

post/devices/deviceGroups
Request samples
{
  • "id": "dgrp_12345",
  • "name": "ACME Inc. - Retail Store",
  • "deviceCount": 5,
  • "status": "active",
  • "clientId": "acmeinc",
  • "industry": "retail",
  • "posMode": "magnetic",
  • "hasZipCodePrompt": true,
  • "hasCvvPrompt": false,
  • "hasTipLine": true,
  • "hasTipRecommendation": false
}
Response samples
{
  • "id": "dgrp_12345",
  • "name": "ACME Inc. - Retail Store",
  • "deviceCount": 5,
  • "status": "active",
  • "clientId": "acmeinc",
  • "industry": "retail",
  • "posMode": "magnetic",
  • "hasZipCodePrompt": true,
  • "hasCvvPrompt": false,
  • "hasTipLine": true,
  • "hasTipRecommendation": false
}
Copyright © Pace Software 2021–2023. All rights reserved.