Update a project

PUT 
/project/:projectId

Update a project

Request

Path Parameters

projectId projectIdrequired

The projectId to update

application/json

Body

Project data

gameEngine string

Game engine

thumbnail urlnullable

Project thumbnail URL

ownerUsername string

New project owner username

members string[]
name string

Possible values: <= 32 characters

Project name

hidden boolean

Hide project

numMonthlyUsers integer

Number of monthly users

platform string

Platform

Responses

200

Project successfully updated

application/json

Schema

Schema

credits integer

The amount of project credits available.

name projectName (string)required

Possible values: <= 32 characters

Name of the project

hidden boolean

Indicates if the project is hidden or visible

platform string

Platform for the project

createdAt date-time

Time representation of Project creation

config objectnullable

Configuration settings for the project

numMonthlyUsers integer

Number of monthly users

id string

Unique identifier for Project

ownerId

Unique identifier of the owner

thumbnail urinullable

URL to the project's thumbnail image

gameEngine string

Possible values: <= 50 characters

The game engine used for the project

members

object[]

Array [

avatar url

name string

cognitoUserId string

]

Example (from schema)

{
  "credits": 100,
  "name": "Call of foodie 2",
  "hidden": false,
  "platform": "[\"pc\",\"linux\", \"xbox\", \"playstation\"]",
  "createdAt": "2024-01-01T09:00:00.00Z",
  "config": "https://file.playmakers.co/cfg/p2Duhf5N6/config.json",
  "numMonthlyUsers": 1500,
  "id": "p2Duhf5N6",
  "ownerId": "ab1a4ade-6eb9-40cd-bb3e-f274af238649",
  "thumbnail": "https://file.playmakers.co/p2Duhf5N6/aUv0OhmsR.jpg",
  "gameEngine": "Unity",
  "members": [
    {
      "avatar": "https://file.playmakers.co",
      "name": "Marwan",
      "cognitoUserId": "170596c9-a3aa-4264-98ec-803799d5fc15"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Unauthorized access"
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...