Labelcamp API v2

Send Tasks

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

Product delivery tasks to DSPs.

Priorities: normal (default), urgent (higher priority), next (immediate, bypasses validations, limited to 1,000/day)

Our smart prioritization system automatically and efficiently organizes deliveries by urgency, even when handling large volumes of content delivered simultaneously. Normal priority is the default level, strongly recommended for most SendTasks. Urgent priority ranks higher than Normal. Next priority ensures the SendTask is processed immediately, ahead of all other waiting deliveries. However, Next should be used only in exceptional cases for last-minute, critical deliveries, as excessive use may disrupt the prioritization system. This priority is subject to a daily quota of 1,000 SendTasks.

Important Note: Selecting "Next" ignores all validations on product, offer, and DSP. The product will be delivered immediately. This action is performed under your responsibility.

List send tasks

GET

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

/send-tasks

Retrieve distribution delivery tasks to DSPs

List send tasks › 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[product-ids]

string

Comma-separated product IDs

filter[dsp-ids]

string

Comma-separated DSP IDs

filter[dsp-upload-identification-ids]

string

Comma-separated DSP upload identification IDs

filter[label-ids]

string

Comma-separated label IDs

filter[company-ids]

string

Comma-separated company IDs

filter[status]

string · enum

Filter by task status

Enum values:

waiting

error

completed

stucked

List send tasks › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

GET/send-tasks

curl --request GET \
  --url https://api.idol.io/api/v2/send-tasks

shell

Example Responses

No example specified for this content type

application/vnd.api+json

Create a send task

POST

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

/send-tasks

Create a new product delivery task

Create a send task › Request Body

object · required

Create a send task › Responses

Send task created successfully

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

POST/send-tasks

curl --request POST \
  --url https://api.idol.io/api/v2/send-tasks \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "send-tasks",
    "id": "id",
    "attributes": {
      "delivery-type": "delivery",
      "deliverable": true,
      "priority": "normal",
      "status": "waiting",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "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": "send-tasks",
    "id": "id",
    "attributes": {
      "delivery-type": "delivery",
      "deliverable": true,
      "priority": "normal",
      "status": "waiting",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "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

Get send task details

GET

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

/send-tasks/{id}

Retrieve details for a specific send task by ID

Get send task details › path Parameters

id

string · required

Resource ID

Get send task details › Responses

Successful response

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/send-tasks/{id}

curl --request GET \
  --url https://api.idol.io/api/v2/send-tasks/:id

shell

Example Responses

No example specified for this content type

application/vnd.api+json

Update a send task

PUT

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

/send-tasks/{id}

Update an existing send task

Update a send task › path Parameters

id

string · required

Resource ID

Update a send task › Request Body

object · required

Update a send task › Responses

Send task updated successfully

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

PUT/send-tasks/{id}

curl --request PUT \
  --url https://api.idol.io/api/v2/send-tasks/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "send-tasks",
    "id": "id",
    "attributes": {
      "delivery-type": "delivery",
      "deliverable": true,
      "priority": "normal",
      "status": "waiting",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "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": "send-tasks",
    "id": "id",
    "attributes": {
      "delivery-type": "delivery",
      "deliverable": true,
      "priority": "normal",
      "status": "waiting",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "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

Import Tasks Send Task Factories

Labelcamp API v2

Send Tasks

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

Product delivery tasks to DSPs.

Priorities: normal (default), urgent (higher priority), next (immediate, bypasses validations, limited to 1,000/day)

Important Note: Selecting "Next" ignores all validations on product, offer, and DSP. The product will be delivered immediately. This action is performed under your responsibility.

List send tasks

GET

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

/send-tasks

Retrieve distribution delivery tasks to DSPs

List send tasks › 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[product-ids]

string

Comma-separated product IDs

filter[dsp-ids]

string

Comma-separated DSP IDs

filter[dsp-upload-identification-ids]

string

Comma-separated DSP upload identification IDs

filter[label-ids]

string

Comma-separated label IDs

filter[company-ids]

string

Comma-separated company IDs

filter[status]

string · enum

Filter by task status

Enum values:

waiting

error

completed

stucked

List send tasks › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

GET/send-tasks

curl --request GET \
  --url https://api.idol.io/api/v2/send-tasks

shell

Example Responses

No example specified for this content type

application/vnd.api+json

Create a send task

POST

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

/send-tasks

Create a new product delivery task

Create a send task › Request Body

object · required

Create a send task › Responses

Send task created successfully

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

POST/send-tasks

curl --request POST \
  --url https://api.idol.io/api/v2/send-tasks \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "send-tasks",
    "id": "id",
    "attributes": {
      "delivery-type": "delivery",
      "deliverable": true,
      "priority": "normal",
      "status": "waiting",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "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": "send-tasks",
    "id": "id",
    "attributes": {
      "delivery-type": "delivery",
      "deliverable": true,
      "priority": "normal",
      "status": "waiting",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "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

Get send task details

GET

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

/send-tasks/{id}

Retrieve details for a specific send task by ID

Get send task details › path Parameters

id

string · required

Resource ID

Get send task details › Responses

Successful response

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/send-tasks/{id}

curl --request GET \
  --url https://api.idol.io/api/v2/send-tasks/:id

shell

Example Responses

No example specified for this content type

application/vnd.api+json

Update a send task

PUT

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

/send-tasks/{id}

Update an existing send task

Update a send task › path Parameters

id

string · required

Resource ID

Update a send task › Request Body

object · required

Update a send task › Responses

Send task updated successfully

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

PUT/send-tasks/{id}

curl --request PUT \
  --url https://api.idol.io/api/v2/send-tasks/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "send-tasks",
    "id": "id",
    "attributes": {
      "delivery-type": "delivery",
      "deliverable": true,
      "priority": "normal",
      "status": "waiting",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "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": "send-tasks",
    "id": "id",
    "attributes": {
      "delivery-type": "delivery",
      "deliverable": true,
      "priority": "normal",
      "status": "waiting",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "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

Import Tasks Send Task Factories