Skip to main content
POST
/
campaigns
/
{campaignId}
/
creative-collections
/
{collectionId}
/
attach
Attach creative collection to campaign
curl --request POST \
  --url https://api.interchange.io/api/v2/buyer/campaigns/{campaignId}/creative-collections/{collectionId}/attach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "creative_library",
  "sync_policy": "manual",
  "metadata": {}
}
'
{
  "collection": {
    "collection_id": "<string>",
    "name": "<string>",
    "member_count": 4503599627370495,
    "creative_count": 4503599627370495,
    "asset_count": 4503599627370495,
    "attached_campaign_count": 4503599627370495,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "campaign_id": "<string>",
    "brand_agent_id": "<string>",
    "description": "<string>",
    "metadata": {},
    "members": [
      {
        "member_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "label": "<string>",
        "metadata": {},
        "creative": {
          "creative_id": "<string>",
          "name": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "asset_count": 3,
          "campaign_id": "<string>",
          "format_id": {
            "id": "<string>",
            "agent_url": "<string>",
            "width": 123,
            "height": 123,
            "duration_ms": 123
          },
          "template_id": "<string>",
          "brand_domain": "<string>",
          "preview_url": "<string>",
          "requires_upgrade": true,
          "sync_status": {
            "synced": true,
            "agent_count": 0
          },
          "target_format_ids": [
            {
              "id": "<string>",
              "agent_url": "<string>",
              "width": 123,
              "height": 123,
              "duration_ms": 123
            }
          ]
        }
      }
    ],
    "attachments": [
      {
        "campaign_id": "<string>",
        "collection_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "metadata": {}
      }
    ]
  },
  "added_count": 4503599627370495,
  "removed_count": 4503599627370495,
  "attached": {
    "campaign_id": "<string>",
    "collection_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  },
  "assigned_count": 4503599627370495,
  "legacy_members_excluded": 4503599627370495
}

Authorizations

​
Authorization
string
header
required

API key or access token

Path Parameters

​
campaignId
string
required
Minimum string length: 1
​
collectionId
string
required
Minimum string length: 1

Body

application/json

Attach collection metadata to the campaign workspace. This does not launch or sync creatives by itself.

​
role
enum<string>
default:creative_library

How a campaign uses the collection: working creative library, source assets, approved launch set, or testing set.

Available options:
creative_library,
source_assets,
approved_set,
test_set
​
sync_policy
enum<string>
default:manual

Whether campaign attachment changes are manual or automatically include new collection members.

Available options:
manual,
auto_include_new_members
​
metadata
object

Response

Attach creative collection to campaign

Mutation response for collection management.

​
collection
object
required

A creative collection owned by an advertiser, campaign, or customer workspace.

​
added_count
integer
Required range: 0 <= x <= 9007199254740991
​
removed_count
integer
Required range: 0 <= x <= 9007199254740991
​
attached
object

Campaign attachment metadata for a creative collection.

​
assigned_count
integer

Number of creative_manifest_campaign rows created by this operation.

Required range: 0 <= x <= 9007199254740991
​
legacy_members_excluded
integer

Creative members skipped because their manifest lacks format_kind (upgrade required).

Required range: 0 <= x <= 9007199254740991