Line Item Curated Categories

Additional details on usage can be found at the Video Views Pre-roll Objective Guide

GET accounts/:account_id/line_item_curated_categories

Retrieve details for some or all line item curated categories associated with the current account.

Resource URL

https://ads-api.twitter.com/8/accounts/:account_id/line_item_curated_categories

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

count
optional

Specifies the number of records to try and retrieve per distinct request.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional

Specifies a cursor to get the next page of results. See Pagination for more information.

Type: string

Example: 8x7v00oow

sort_by
optional

Sorts by supported attribute in ascending or descending order. See Sorting for more information.

Type: string

Example: created_at-asc

with_deleted
optional

Include deleted results in your request.

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional

Include the total_count response attribute.

Note: This parameter and cursor are exclusive.

Note: Requests which include total_count will have lower rate limits, currently set at 200 per 15 minutes.

Type: boolean

Default: false
Possible values: true, false

Example Request

GET https://ads-api.twitter.com/8/accounts/abc1/line_item_curated_categories

Example Response

{
  "request": {
    "params": {
      "account_id": "abc1"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "line_item_id": "by5pw",
      "curated_category_id": "7op29tp2jzeo",
      "id": "1",
      "created_at": "2018-06-29T04:19:53Z",
      "updated_at": "2018-06-29T04:19:53Z",
      "deleted": false
    }
  ]
}

GET accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

Retrieves details for a specific line item curated category associated with the current account.

Resource URL

https://ads-api.twitter.com/8/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

line_item_curated_category_id
required

A reference to the line item curated category you are operating with in the request.

Type: string

Example: 43853bhii885

with_deleted
optional

Include deleted results in your request.

Type: boolean

Default: false
Possible values: true, false

Example Request

GET https://ads-api.twitter.com/8/accounts/abc1/line_item_curated_categories/yav

Example Response

{
  "request": {
    "params": {
      "line_item_curated_category_id": "yav",
      "account_id": "abc1"
    }
  },
  "data": {
    "line_item_id": "by5pw",
    "curated_category_id": "7op29tp2jzeo",
    "id": "yav",
    "created_at": "2018-06-29T04:19:53Z",
    "updated_at": "2018-06-29T04:19:53Z",
    "deleted": false
  }
}

POST accounts/:account_id/line_item_curated_categories

Associate a curated category object with the specified line item.

Resource URL

https://ads-api.twitter.com/8/accounts/:account_id/line_item_curated_categories

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

curated_category_id
required

A reference to the curated category entity you are operating with in the request.

Type: string

Example: 10miy

line_item_id
required

A reference to the line item you are operating with in the request.

Type: string

Example: 8v7jo

Example Request

POST https://ads-api.twitter.com/8/accounts/18ce54d4x5t/line_item_curated_categories?line_item_id=iqwka&curated_category_id=9ddrgesiap6o

Example Response

{
  "request": {
    "params": {
      "curated_category_id": "9ddrgesiap6o",
      "line_item_id": "iqwka",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "iqwka",
    "curated_category_id": "9ddrgesiap6o",
    "id": "xq",
    "created_at": "2021-03-30T17:26:42Z",
    "updated_at": "2021-03-30T17:26:42Z",
    "deleted": false
  }
}

PUT accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

Update the specified line item curated category.

Resource URL

https://ads-api.twitter.com/8/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

line_item_curated_category_id
required

A reference to the line item curated category you are operating with in the request.

Type: string

Example: 1bzq3

curated_category_id
optional

A reference to the curated category entity you are operating with in the request.

Type: string

Example: 10miy

line_item_id
optional

A reference to the line item you are operating with in the request.

Type: string

Example: 8v7jo

Example Request

PUT https://ads-api.twitter.com/8/accounts/18ce54d4x5t/line_item_curated_categories/xq?curated_category_id=8tujl1p3yn0g

Example Response

{
  "request": {
    "params": {
      "line_item_curated_category_id": "xq",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "iqwka",
    "curated_category_id": "8tujl1p3yn0g",
    "id": "xq",
    "created_at": "2021-03-30T17:26:42Z",
    "updated_at": "2021-03-30T18:22:52Z",
    "deleted": true
  }
}

DELETE accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

Delete the specified line item curated category.

Resource URL

https://ads-api.twitter.com/8/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

line_item_curated_category_id
required

A reference to the line item curated category you are operating with in the request.

Type: string

Example: 1bzq3

Example Request

DELETE https://ads-api.twitter.com/8/accounts/18ce54d4x5t/line_item_curated_categories/xq

Example Response

{
  "request": {
    "params": {
      "line_item_curated_category_id": "xq",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "iqwka",
    "curated_category_id": "9ddrgesiap6o",
    "id": "xq",
    "created_at": "2021-03-30T17:26:42Z",
    "updated_at": "2021-03-30T18:22:52Z",
    "deleted": true
  }
}
Was this document helpful?
Thank you

Thank you for the feedback. We’re really glad we could help!

Thank you for the feedback. How could we improve this document?
Thank you for the feedback. Your comments will help us improve our documents in the future.