SendTask

List SendTasks

GET https://api.idol.io/api/v2/send-tasks

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200 Cake successfully retrieved.

{
  "data": {
    "id": "<ID>",
    "type": "send-tasks",
    "links": {
      "self": "https://api.idol.io/api/v2/send-tasks/<ID>"
    },
    "attributes": {
      "created-at": "2024-05-30T17:58:13.310+02:00",
      "updated-at": "2024-05-30T17:58:13.303+02:00",
      "validation-type": "backcatalogue",
      "deliverable": "true",
      "priority": "normal"
    },
    "relationships": {
      "product": {
        "links": {
          "self": "https://api.idol.io/api/v2/send-tasks/<ID>/relationships/product",
          "related": "https://api.idol.io/api/v2/send-tasks/<ID>/product"
        },
        "data": {
          "type": "products",
          "id": "<ID>"
        }
      },
      "dsp-upload-identification": {
        "links": {
          "self": "https://api.idol.io/api/v2/send-tasks/<ID>/relationships/dsp-upload-identification",
          "related": "https://api.idol.io/api/v2/send-tasks/<ID>/dsp-upload-identification"
        },
        "data": {
          "type": "dsp-upload-identifications",
          "id": "<ID>"
        }
      }
    }
  }
}

Filter resources

Products

api/v2/send-tasks?filter[product-ids]=1,2

Dsps

api/v2/send-tasks?filter[dsp-ids]=1,2

DspUploadIdentifications

api/v2/send-tasks?filter[dsp-upload-identification-ids]=1,2

Labels

api/v2/send-tasks?filter[label-ids]=1,2

Companies

api/v2/send-tasks?filter[company-ids]=1,2

Status

# waiting
# error
# completed
# stucked

api/v2/send-tasks?filter[status]=waiting

Get SendTask

GET https://api.idol.io/api/v2/send-tasks/:id

Path Parameters

Name	Type	Description
id*	string	ID of the send-task

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data": {
    "id": "<ID>",
    "type": "send-tasks",
    "links": {
      "self": "https://api.idol.io/api/v2/send-tasks/<ID>"
    },
    "attributes": {
      "created-at": "2024-07-09T15:52:20.142+02:00",
      "updated-at": "2024-07-27T11:34:46.219+02:00",
      "deliverable": "true",
      "delivery-type": "delivery",
      "priority": "normal"
    },
    "relationships": {
      "product": {
        "links": {
          "self": "https://api.idol.io/api/v2/send-tasks/<ID>/relationships/product",
          "related": "https://api.idol.io/api/v2/send-tasks/<ID>/product"
        },
        "data": {
          "type": "products",
          "id": "<ID>"
        }
      },
      "dsp-upload-identification": {
        "links": {
          "self": "https://api.idol.io/api/v2/send-tasks/<ID>/relationships/dsp-upload-identification",
          "related": "https://api.idol.io/api/v2/send-tasks/<ID>/dsp-upload-identification"
        },
        "data": {
          "type": "dsp-upload-identifications",
          "id": "<ID>"
        }
      }
    }
  }
}

Create SendTask

POST https://api.idol.io/api/v2/send-tasks

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

Request Body

Name	Type	Description
product*	object	Product Object
dsp-upload-identification*	object	DspUploadIdentification Object
delivery-type*	string	delivery / update / redelivery / delete
deliverable*	boolean	true
priority	string	normal / urgent / next

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.

200

{
  "data": {
    "id": "<ID>",
    "type": "send-tasks",
    "links": {
      "self": "https://api.idol.io/api/v2/send-tasks/<ID>"
    },
    "attributes": {
      "created-at": "2024-05-30T17:58:13.310+02:00",
      "updated-at": "2024-05-30T17:58:13.303+02:00",
      "deliverable": "true",
      "delivery-type": "delivery",
      "priority": "normal"
    },
    "relationships": {
      "product": {
        "links": {
          "self": "https://api.idol.io/api/v2/send-tasks/<ID>/relationships/product",
          "related": "https://api.idol.io/api/v2/send-tasks/<ID>/product"
        },
        "data": {
          "type": "products",
          "id": "<ID>"
        }
      },
      "dsp-upload-identification": {
        "links": {
          "self": "https://api.idol.io/api/v2/send-tasks/<ID>/relationships/dsp-upload-identification",
          "related": "https://api.idol.io/api/v2/send-tasks/<ID>/dsp-upload-identification"
        },
        "data": {
          "type": "dsp-upload-identifications",
          "id": "<ID>"
        }
      }
    }
  }
}

Update SendTask

PUT https://api.idol.io/api/v2/send-tasks/:id

Path Parameters

Name	Type	Description
id*	number	ID of the send task

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

Request Body

Name	Type	Description
product*	object	Product Object
dsp-upload-identification*	object	DspUploadIdentification Object
delivery-type*	string	delivery / update / redelivery / delete
deliverable*	boolean	true
priority	string	normal / urgent / next

200

{
  "data": {
    "id": "<ID>",
    "type": "send-tasks",
    "links": {
      "self": "https://api.idol.io/api/v2/send-tasks/<ID>"
    },
    "attributes": {
      "created-at": "2024-05-30T17:58:13.310+02:00",
      "updated-at": "2024-05-30T17:58:13.303+02:00",
      "deliverable": "true",
      "delivery-type": "delivery",
      "priority": "normal"
    },
    "relationships": {
      "product": {
        "links": {
          "self": "https://api.idol.io/api/v2/send-tasks/<ID>/relationships/product",
          "related": "https://api.idol.io/api/v2/send-tasks/<ID>/product"
        },
        "data": {
          "type": "products",
          "id": "<ID>"
        }
      },
      "dsp-upload-identification": {
        "links": {
          "self": "https://api.idol.io/api/v2/send-tasks/<ID>/relationships/dsp-upload-identification",
          "related": "https://api.idol.io/api/v2/send-tasks/<ID>/dsp-upload-identification"
        },
        "data": {
          "type": "dsp-upload-identifications",
          "id": "<ID>"
        }
      }
    }
  }
}