Labelcamp API v2

Send Task Factories

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

Send task factory management for bulk distribution operations.

Delivery types: delivery, update, redelivery, delete

Key features:

Bulk send task creation
Track counts by status (completed, waiting, sending, error, stuck)
Configure send dates, release dates, UPCs, and comments

Efficiently manage large-scale distribution operations across multiple platforms.

List send task factories

GET

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

/send-task-factories

Retrieve send task factories for bulk distribution operations

List send task factories › 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[label-ids]

string

Comma-separated label IDs

filter[company-ids]

string

Comma-separated company IDs

filter[delivery-type]

string · enum

Filter by delivery type

Enum values:

delivery

update

redelivery

delete

List send task factories › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

GET/send-task-factories

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

shell

Example Responses

No example specified for this content type

application/vnd.api+json

Create a send task factory

POST

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

/send-task-factories

Create a new send task factory for bulk distribution

Create a send task factory › Request Body

object · required

Create a send task factory › Responses

Send task factory created successfully

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

POST/send-task-factories

curl --request POST \
  --url https://api.idol.io/api/v2/send-task-factories \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "send-task-factories",
    "id": "id",
    "attributes": {
      "delivery-type": "delivery",
      "deliverable": true,
      "all-releases": true,
      "add-rights": true,
      "remove-rights": true,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "send-date": "2024-08-25",
      "release-date": "2024-08-25",
      "upcs": [
        "string"
      ],
      "name": {},
      "comment": {},
      "send-tasks-total-count": 0,
      "send-tasks-completed-count": 0,
      "send-tasks-waiting-count": 0,
      "send-tasks-sending-count": 0,
      "send-tasks-error-count": 0,
      "send-tasks-stuck-count": 0
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "user": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "target": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identifications": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "send-tasks": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "logs": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "send-task-factories",
    "id": "id",
    "attributes": {
      "delivery-type": "delivery",
      "deliverable": true,
      "all-releases": true,
      "add-rights": true,
      "remove-rights": true,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "send-date": "2024-08-25",
      "release-date": "2024-08-25",
      "upcs": [
        "string"
      ],
      "name": {},
      "comment": {},
      "send-tasks-total-count": 0,
      "send-tasks-completed-count": 0,
      "send-tasks-waiting-count": 0,
      "send-tasks-sending-count": 0,
      "send-tasks-error-count": 0,
      "send-tasks-stuck-count": 0
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "user": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "target": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identifications": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "send-tasks": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "logs": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Get send task factory details

GET

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

/send-task-factories/{id}

Retrieve details for a specific send task factory by ID

Get send task factory details › path Parameters

id

string · required

Resource ID

Get send task factory details › Responses

Successful response

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/send-task-factories/{id}

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

shell

Example Responses

No example specified for this content type

application/vnd.api+json

Send Tasks Asset Attachments

Labelcamp API v2

Send Task Factories

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

Send task factory management for bulk distribution operations.

Delivery types: delivery, update, redelivery, delete

Key features:

Bulk send task creation
Track counts by status (completed, waiting, sending, error, stuck)
Configure send dates, release dates, UPCs, and comments

Efficiently manage large-scale distribution operations across multiple platforms.

List send task factories

GET

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

/send-task-factories

Retrieve send task factories for bulk distribution operations

List send task factories › 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[label-ids]

string

Comma-separated label IDs

filter[company-ids]

string

Comma-separated company IDs

filter[delivery-type]

string · enum

Filter by delivery type

Enum values:

delivery

update

redelivery

delete

List send task factories › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

GET/send-task-factories

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

shell

Example Responses

No example specified for this content type

application/vnd.api+json

Create a send task factory

POST

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

/send-task-factories

Create a new send task factory for bulk distribution

Create a send task factory › Request Body

object · required

Create a send task factory › Responses

Send task factory created successfully

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

POST/send-task-factories

curl --request POST \
  --url https://api.idol.io/api/v2/send-task-factories \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "send-task-factories",
    "id": "id",
    "attributes": {
      "delivery-type": "delivery",
      "deliverable": true,
      "all-releases": true,
      "add-rights": true,
      "remove-rights": true,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "send-date": "2024-08-25",
      "release-date": "2024-08-25",
      "upcs": [
        "string"
      ],
      "name": {},
      "comment": {},
      "send-tasks-total-count": 0,
      "send-tasks-completed-count": 0,
      "send-tasks-waiting-count": 0,
      "send-tasks-sending-count": 0,
      "send-tasks-error-count": 0,
      "send-tasks-stuck-count": 0
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "user": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "target": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identifications": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "send-tasks": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "logs": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "send-task-factories",
    "id": "id",
    "attributes": {
      "delivery-type": "delivery",
      "deliverable": true,
      "all-releases": true,
      "add-rights": true,
      "remove-rights": true,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "send-date": "2024-08-25",
      "release-date": "2024-08-25",
      "upcs": [
        "string"
      ],
      "name": {},
      "comment": {},
      "send-tasks-total-count": 0,
      "send-tasks-completed-count": 0,
      "send-tasks-waiting-count": 0,
      "send-tasks-sending-count": 0,
      "send-tasks-error-count": 0,
      "send-tasks-stuck-count": 0
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "user": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "target": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identifications": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "send-tasks": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "logs": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Get send task factory details

GET

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

/send-task-factories/{id}

Retrieve details for a specific send task factory by ID

Get send task factory details › path Parameters

id

string · required

Resource ID

Get send task factory details › Responses

Successful response

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/send-task-factories/{id}

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

shell

Example Responses

No example specified for this content type

application/vnd.api+json

Send Tasks Asset Attachments