Upload an image (multipart 'file' or JSON base64) on behalf of an installed app.

POST

/apps/media/uploads

curl --request POST \
  --url https://your-store.myciqra.com/apps/media/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "contentBase64": "example", "fileName": "example" }'

Required scope: write_media — an installation token without it receives 403.

Authorizations

• bearerAuth
  write_media

Request Body^required

object

contentBase64

required

null | string

fileName

required

null | string

Example^generated

{
  "contentBase64": "example",
  "fileName": "example"
}

object

contentBase64

required

null | string

fileName

required

null | string

Responses

201

Created

Media typeapplication/json

object

contentType

required

string

fileName

required

string

height

required

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

mediaAssetId

required

string format: uuid

sizeBytes

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

storageKey

required

string

url

required

string

width

required

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

Example^generated

{
  "contentType": "example",
  "fileName": "example",
  "height": 1,
  "mediaAssetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "sizeBytes": 1,
  "storageKey": "example",
  "url": "example",
  "width": 1
}

400

Bad Request

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}

409

Conflict

413

Payload Too Large

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}