Execute Command

Execute an ER:LC command.

POST https://api.sonorancms.com/v2/community/erlc/commands

Rate limit: 18 requests per minute

Authenticated v2 endpoints are rate limited per credential rather than per IP address.

Execute an ER:LC command.

Request Body

| Name | Type | Required | Description |

| --- | --- | --- | --- |

| robloxJoinCode | string | Yes | See example request for the shape. |

| discordId | string | Yes | See example request for the shape. |

| type | string | Yes | See example request for the shape. |

| args | string | Yes | See example request for the shape. |

| includesPlayerNameOrId | boolean | Yes | See example request for the shape. |

Example Request

local Sonoran = require("sonoran")

local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CMS,
  apiKey = "YOUR_API_KEY",
  communityId = "YOUR_COMMUNITY_ID",
  defaultServerId = 1,
  timeoutMs = 30000,
})

local payload = {
  ["robloxJoinCode"] = "ABC123",
  ["discordId"] = "1234567890",
  ["type"] = "announce",
  ["args"] = "Server restart in 10 minutes",
  ["includesPlayerNameOrId"] = false
}

local response = sonoran.cms:executeErlcCommandV2(payload)

if response.success then
  print(response.data)
else
  print(response.reason)
end

Response

The data value is a confirmation string once the command has been queued for ERLC execution.

Last updated

Was this helpful?