Skip to main content
PATCH
/
community
/
{id}
/
experience
/
{experienceId}
Update experience
curl --request PATCH \
  --url https://api.op.xyz/v1/community/{id}/experience/{experienceId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "imageUrl": "<string>",
  "bannerUrl": "<string>",
  "codeUrl": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "public": true,
  "secret": "<string>",
  "imageUrl": "<string>",
  "bannerUrl": "<string>",
  "experienceUrl": "<string>",
  "serverId": "<string>",
  "serverStatus": "active",
  "codeUrl": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "type": "web",
  "communityId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "leaderboard": {
    "badgeId": "<string>",
    "metric": "<string>",
    "direction": "ASC",
    "totalPlays": 123,
    "prizes": [
      {
        "name": "<string>",
        "description": "<string>",
        "imageUrl": "<string>"
      }
    ]
  }
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
id
string
required

Community ID

​
experienceId
string
required

Body

application/json
​
name
string
required
​
description
string
required
​
imageUrl
string
required
​
bannerUrl
string
required
​
codeUrl
string
required
​
startDate
string<date-time>
required
​
endDate
string<date-time>
required

Response

The experience has been successfully updated

​
id
string
required
​
name
string
required
​
description
string
required
​
public
boolean
required
​
secret
string
required
​
imageUrl
string
required
​
bannerUrl
string
required
​
experienceUrl
string
required
​
serverId
string
required
​
serverStatus
enum<string>
required
Available options:
active,
inactive
​
codeUrl
string
required
​
startDate
string<date-time>
required
​
endDate
string<date-time>
required
​
type
enum<string>
required
Available options:
web,
mml,
unity,
instant
​
communityId
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
leaderboard
object