Asset Attachments

Endpointhttps://api.idol.io/api/v2

Models marketing items that can be attached to products, like Apple Motion Arts.

Supported formats:

apple_motion_art_mobile: Mobile format (3:4 aspect ratio)
apple_motion_art_desktop: Desktop format (1:1 aspect ratio)

Currently supported attachable types: Product only

Asset attachments allow you to associate additional media assets with products for enhanced presentation on digital platforms.

List asset attachments

GET

https://api.idol.io/api/v2

/asset-attachments

Retrieve a paginated list of asset attachments

List asset attachments › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

filter[attachable-type]

string · enum

Filter by attachable type (currently only "Product" is supported)

Enum values:

Product

filter[attachable-id]

string

Filter by attachable ID (e.g., product ID)

List asset attachments › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create an asset attachment

POST

https://api.idol.io/api/v2

/asset-attachments

Create a new asset attachment for a product.

Required fields: attachable-type, attachable-id, kind

Create an asset attachment › Request Body

object · required

Create an asset attachment › Responses

Asset attachment created successfully

object

object[]

Related resources included in the response

object

Get asset attachment details

GET

https://api.idol.io/api/v2

/asset-attachments/{id}

Retrieve a single asset attachment by ID

Get asset attachment details › path Parameters

id

string · required

Resource ID

Get asset attachment details › query Parameters

include

string

Comma-separated list of related resources to include

Get asset attachment details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update an asset attachment

PUT

https://api.idol.io/api/v2

/asset-attachments/{id}

Update an existing asset attachment.

Updatable field: priority

Update an asset attachment › path Parameters

id

string · required

Resource ID

Update an asset attachment › Request Body

object · required

Update an asset attachment › Responses

Asset attachment updated successfully

object

object[]

Related resources included in the response

object

PUT/asset-attachments/{id}

curl --request PUT \
  --url https://api.idol.io/api/v2/asset-attachments/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "asset-attachments",
    "id": "id",
    "attributes": {
      "kind": "apple_motion_art_mobile",
      "file": "file",
      "file-md5": "file-md5",
      "file-url": "https://www.example.com/path/to/resource",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "attachable": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "asset-attachments",
    "id": "id",
    "attributes": {
      "kind": "apple_motion_art_mobile",
      "file": "file",
      "file-md5": "file-md5",
      "file-url": "https://www.example.com/path/to/resource",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "attachable": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Delete an asset attachment

DELETE

https://api.idol.io/api/v2

/asset-attachments/{id}

Delete an asset attachment

Delete an asset attachment › path Parameters

id

string · required

Resource ID

Delete an asset attachment › Responses

Asset attachment deleted successfully

No data returned

Send Task Factories Track Videos

Labelcamp API v2

Asset Attachments

Endpointhttps://api.idol.io/api/v2

Models marketing items that can be attached to products, like Apple Motion Arts.

Supported formats:

apple_motion_art_mobile: Mobile format (3:4 aspect ratio)
apple_motion_art_desktop: Desktop format (1:1 aspect ratio)

Currently supported attachable types: Product only

Asset attachments allow you to associate additional media assets with products for enhanced presentation on digital platforms.

List asset attachments

GET

https://api.idol.io/api/v2

/asset-attachments

Retrieve a paginated list of asset attachments

List asset attachments › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

filter[attachable-type]

string · enum

Filter by attachable type (currently only "Product" is supported)

Enum values:

Product

filter[attachable-id]

string

Filter by attachable ID (e.g., product ID)

List asset attachments › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create an asset attachment

POST

https://api.idol.io/api/v2

/asset-attachments

Create a new asset attachment for a product.

Required fields: attachable-type, attachable-id, kind

Create an asset attachment › Request Body

object · required

Create an asset attachment › Responses

Asset attachment created successfully

object

object[]

Related resources included in the response

object

Get asset attachment details

GET

https://api.idol.io/api/v2

/asset-attachments/{id}

Retrieve a single asset attachment by ID

Get asset attachment details › path Parameters

id

string · required

Resource ID

Get asset attachment details › query Parameters

include

string

Comma-separated list of related resources to include

Get asset attachment details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update an asset attachment

PUT

https://api.idol.io/api/v2

/asset-attachments/{id}

Update an existing asset attachment.

Updatable field: priority

Update an asset attachment › path Parameters

id

string · required

Resource ID

Update an asset attachment › Request Body

object · required

Update an asset attachment › Responses

Asset attachment updated successfully

object

object[]

Related resources included in the response

object

PUT/asset-attachments/{id}

curl --request PUT \
  --url https://api.idol.io/api/v2/asset-attachments/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "asset-attachments",
    "id": "id",
    "attributes": {
      "kind": "apple_motion_art_mobile",
      "file": "file",
      "file-md5": "file-md5",
      "file-url": "https://www.example.com/path/to/resource",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "attachable": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "asset-attachments",
    "id": "id",
    "attributes": {
      "kind": "apple_motion_art_mobile",
      "file": "file",
      "file-md5": "file-md5",
      "file-url": "https://www.example.com/path/to/resource",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "attachable": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Delete an asset attachment

DELETE

https://api.idol.io/api/v2

/asset-attachments/{id}

Delete an asset attachment

Delete an asset attachment › path Parameters

id

string · required

Resource ID

Delete an asset attachment › Responses

Asset attachment deleted successfully

No data returned

Send Task Factories Track Videos