Update executor

Update your executor in our executors list

NOTE: Unlike other endpoints in this documentation, this endpoint is a POST endpoint.

The update endpoint allows you to update you executor's information in our executors list, including name, description, discord link, and much more.

API Path

The API path for this endpoint is /api/executor/update

The endpoint accepts the following body:

Key	Description	Required	Type	Default
id	The name of the executor to update	✅	`string`	-
api_key	The API key of the executor	✅	`string`	-
name	New name for the executor	❌	`string`	-
description	The description of the executor	❌	`string`	-
platform	The platform the executor works on	❌	`iOS` \| `Android` \| `Windows` \| `macOS` \| `Roblox VNG`	-
patched	Whether or not the executor is patched	❌	`boolean`	-
website	Executor website	❌	`string`	-
discord	The discord server of the executor	❌	Valid Discord link	-
store	Executor store link	❌	`string`	-
version	The version of the executor (for manual overrides, generally unnecessary if you set up a version endpoint)	❌	`string`	-
playerVersion	The compatible client version (for manual overrides, generally unnecessary if you set up a version endpoint)	❌	`string`	-
endpoint	The version endpoint (for automatic version tracking)	❌	Valid URL	-
developers	The list of developers, as a single string	❌	`string`	-
update	Whether or not this should trigger a visible update on site (this should be turned off in case of, for example, typo fixes)	❌	`boolean`	`true`

If the update succeeded, the following response will be returned:

{
    "message": "Executor updated successfully!"
}

If no changes were found (fields weren't provided or are matching the current ones), the following response will be returned:

{
    "message": "No changes detected!"
}

If an error occurs, the response will contain a single message field:

{
    "message": "string"
}

Fetch executors

Fetch the list of our available executors

Migration

Migration steps to the new API