Change a project

PATCH

/v1/projects/{slug}

curl --request PATCH \
  --url https://api.gampeon.com/v1/projects/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "tagline": "example", "description": "example", "genre": "roleplay", "status": "concept", "tags": [ "example" ], "languages": [ "en" ], "links": { "discord": "example", "youtube": "example", "x": "example", "twitch": "example", "tiktok": "example", "steam": "example" }, "website": "example", "published": true }'

• Production

Owner of the project, or owners and admins of its studio. Fields you leave out stay unchanged; links only changes the links you send. published: true publishes a draft (needs a tagline and an about text with at least 100 characters), false turns it back into a draft.

Access tokens: scope projects:write.

Rate limit: 120 edits per hour per account.

Authorizations

• session
• accessToken
  projects:write

Parameters

Path Parameters

slug

required

string

/^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$/

Project slug

Request Body^required

Media typeapplication/json

object

title

string

>= 2 characters <= 64 characters

tagline

string

<= 120 characters

description

Markdown

string

<= 8000 characters

genre

string

Allowed values: roleplay racing shooter survival parkour sandbox minigames simulation other

status

string

Allowed values: concept development alpha beta released

tags

Up to 10 lowercase tags (a-z, 0-9, -, max. 24 characters each).

Array<string>

<= 10 items

languages

Up to 10 languages (ISO 639-1)

Array<string>

<= 10 items

Allowed values: en de fr es it pt nl pl cs sk hu ro bg el tr ru uk sv da no fi ar he hi th vi id ja ko zh

links

Links besides the website: Discord invite, YouTube channel, X, Twitch, TikTok profile, Steam store page. Only https://. In a change, an empty string removes a link.

object

discord

string

youtube

string

x

string

twitch

string

tiktok

string

steam

string

website

Website. Only https:// URLs, empty string removes it.

string

<= 200 characters /^$|^https://[^\s<>"]+$/

published

boolean

Responses

200

Updated project

Media typeapplication/json

object

slug

required

string

/^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$/

title

required

string

tagline

required

string

genre

required

string

Allowed values: roleplay racing shooter survival parkour sandbox minigames simulation other

tags

required

Array<string>

status

required

Development stage, in this order: concept, development, alpha, beta, released

string

Allowed values: concept development alpha beta released

languages

required

Languages of the game (ISO 639-1), up to 10

Array<string>

Allowed values: en de fr es it pt nl pl cs sk hu ro bg el tr ru uk sv da no fi ar he hi th vi id ja ko zh

cover

required

One of:

string

Image path relative to the API (/v1/media/…). null without an image.

string

null

null

owner

required

One of:

object

object

type

required

Allowed value: studio

slug

required

string

name

required

string

logo

One of:

string

Image path relative to the API (/v1/media/…). null without an image.

string

null

null

object

object

type

required

Allowed value: user

handle

required

string

displayName

required

string

avatar

One of:

string

Image path relative to the API (/v1/media/…). null without an image.

string

null

null

players

required

Players on linked servers that are online

integer

online

required

Linked servers that are online

integer

items

required

Linked marketplace items with at least one free version

integer

favorites

required

Accounts that marked the project as a favorite

integer

views

required

Page views (counted once per visitor and day, the team not included)

integer

createdAt

required

Unix time in milliseconds

integer format: int64

updatedAt

required

Unix time in milliseconds

integer format: int64

releasedAt

required

One of:

integer

First time the status was set to released

integer format: int64

null

null

publishedAt

required

One of:

integer

When the project was published. null: draft, only the team sees it

integer format: int64

null

null

Example

{
  "genre": "roleplay",
  "status": "concept",
  "languages": [
    "en"
  ],
  "owner": {
    "type": "studio"
  }
}

400

Error codes: invalid_field

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

401

Error codes: unauthorized

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

403

Error codes: insufficient_scope, token_not_allowed, forbidden, project_hidden

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

404

Error codes: not_found

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

422

Error codes: publish_requirements

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

429

Limit: 120 edits per hour per account. Error codes: rate_limited

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}