Brands

Initialize a brand element binary upload

Changed on

This endpoint initializes a block-based upload session for a new binary element within a Brand identified by its assetId. It validates the element metadata, reserves upload capacity, and returns pre-signed transfer URLs along with an uploadId to be used in the finalize call.

NOTE: This flow is intended for binary brand elements such as images, videos, and other files.

After receiving transferLinks, clients upload raw binary blocks directly to the provided URLs: PUT <transferURL> <binary data>

  • Authorization Header: Must NOT be included in the request.
  • Success Response: 200 OK indicates successful block upload.
  • Expiration Handling: Each upload session is time-bound. If blocks are not uploaded within the specified expiration window (urlExpirationDate), the operation may fail.
post/brands/{assetId}/elements/init

Request

  • Base URL: https://cloudstorage.adobe.io/v1
  • URL: https://cloudstorage.adobe.io/v1/brands/{assetId}/elements/init
  • Auth: HTTP bearer

Path parameters

assetIdstring required

A globally unique identifier for the asset

Example:urn:aaid:sc:US:4f2fc15c-c062-4951-b37b-1f65ed62a174

The ID of the asset to get.

Headers

x-request-idstring
Example:1234567890

The X-Request-Id header is used to identify a request.
It can be used to correlate logs and other resources and is intended to be a non-persistent identifier.

Request body

namestring required

The name of the asset (including the extension, in case of a file)

The name must not be a

  • reserved Windows name
    • CON
    • PRN
    • AUX
    • NUL
    • COM1 through COM9
    • LPT1 through LPT9
  • contain any of the following characters:
    • \
    • /
    • :
    • *
    • ?
    • "
    • |
    • >
    • <
sizeinteger required

The size of the file in bytes.

mediaTypestring required

The media type of the brand element.

blockSizeinteger

The size of each block in bytes. The block size returned may differ from the size requested.

Example request

{
  "size": 1048576,
  "mediaType": "application/vnd.adobe.element.image+dcx",
  "blockSize": 1048576,
  "elementRoles": [
    {
      "usage": "logo",
      "priority": "primary"
    }
  ]
}

Response

Success - Upload Id along with urls for upload

uploadIdstring

The upload id

blockSizeinteger

The size of each block in bytes

urlExpirationDatestring date-time

Example response

{
  "uploadId": "123e4567-e89b-12d3-a456-426614174000",
  "blockSize": 1048576,
  "urlExpirationDate": "2021-01-01T00:00:00Z",
  "transferLinks": [
    {
      "partNumber": 1
    }
  ]
}

Changes