---
title: "Command Add"
method: POST
path: "/command"
tags: ["command"]
---

# Command Add

`POST /command`

Add a Command

## Response `201`

successful operation

- Command — Class Command
  - `commandId` integer — Command Id
  - `command` string — Command Name
  - `code` string — Unique Code
  - `description` string — Description
  - `userId` integer — User Id
  - `commandString` string — Command String
  - `validationString` string — Validation String
  - `displayProfileId` integer — DisplayProfileId if specific to a Display Profile
  - `commandStringDisplayProfile` string — Command String specific to the provided DisplayProfile
  - `validationStringDisplayProfile` string — Validation String specific to the provided DisplayProfile
  - `availableOn` string — A comma separated list of player types this command is available on
  - `createAlertOn` string — Define if execution of this command should create an alert on success, failure, always or never.
  - `createAlertOnDisplayProfile` unknown
  - `groupsWithPermissions` string — A comma separated list of groups/users with permissions to this Command

## Changes

- **2026-02-25** `41c04de98ec5` — 1 breaking, 1 info
  - added required request body
  - added the media type `application/json` for the response with the status `201`
- **2020-02-17** `8e1275395104` — 2 breaking
  - removed the request body
  - removed the media type `application/json` for the response with the status `201`

[Change history](https://skmtc.dev/xibosignage/apis/xibo-api/changes/command/post.md)

---

[API](https://skmtc.dev/xibosignage/apis/xibo-api.md) · [All operations](https://skmtc.dev/xibosignage/apis/xibo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xibosignage/xibo-api/revisions/9136e3c2cb1d/schema)