Yapper Docs
Api reference
PATCH
/elements/{elementId}

Changes the @ID (also the name), category, description (null clears either), images and main image. Omitted fields stay as they are. A removed main image falls back to the next one the app would pick.

Authorization

bearerAuth assets:write
AuthorizationBearer <token>

In: header

Scope: assets:write

Path Parameters

elementId*string

Element id, or on GET its @ID ("@hero", URL-encoded as %40hero or not).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/elements/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "mentionId": "string",  "tag": "string",  "name": "string",  "category": "character",  "description": "string",  "mainImage": {    "id": "string",    "type": "image",    "url": "string",    "width": 0,    "height": 0,    "name": "string",    "tag": "string",    "webUrl": "http://example.com"  },  "images": [    {      "id": "string",      "type": "image",      "url": "string",      "width": 0,      "height": 0,      "name": "string",      "tag": "string",      "webUrl": "http://example.com"    }  ],  "usable": true,  "createdByUserId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "lastUsedAt": "2019-08-24T14:15:22Z",  "webUrl": "http://example.com",  "links": {    "self": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}