---
title: Campaign
slug: content-marketing-platform/api/K3Pd-campaign
docTags: 
createdAt: 2026-06-24T17:42:48.601Z
---

## campaign\_added

A campaign was added.

### Payload

| **Key**                                 | **Type**         | **Description**                                                                                                                                                |
| --------------------------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| event\_name                             | string           | Name of the event. The value is `campaign_added`.                                                                                                              |
| data                                    | object           | Data of the event.                                                                                                                                             |
| data\[campaign]                         | object           | Data of the campaign associated with the event.                                                                                                                |
| data\[campaign]\[id]                    | string           | Unique identifier of the campaign.                                                                                                                             |
| data\[campaign]\[links]                 | object           | Links related to the campaign.                                                                                                                                 |
| data\[campaign]\[links]\[self]          | string           | URL to fetch the campaign's details through the CMP Open API.                                                                                                  |
| data\[campaign]\[links]\[work\_request] | string or `null` | URL to fetch the work request's details through the CMP Open API. The URL is available if a campaign was started from a work request. Otherwise, it is `null`. |

### Example

When a campaign is added:

```json
{
  "event_name": "campaign_added",
  "data": {
    "campaign": {
      "id": "8q7f910551b00a722e0418830cee6612",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612",
        "work_request": null
      }
    }
  }
}
```

When a campaign is added from a work request:

```json
{
  "event_name": "campaign_added",
  "data": {
    "campaign": {
      "id": "8q7f910551b00a722e0418830cee6612",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612",
        "work_request": "https://api.cmp.optimizely.com/v3/work-requests/9q7f910551b00a722e0418830cee6613"
      }
    }
  }
}
```

## campaign\_metadata\_modified

Any of the following campaign properties are modified:

- Title
- Description
- Start date
- End date
- Is archived
- Labels
- Owner

### Payload

| **Key**                        | **Type** | **Description**                                               |
| ------------------------------ | -------- | ------------------------------------------------------------- |
| event\_name                    | string   | Name of the event. The value is `campaign_metadata_modified`. |
| data                           | object   | Data of the event.                                            |
| data\[campaign]                | object   | Data of the campaign associated with the event.               |
| data\[campaign]\[id]           | string   | Unique identifier of the campaign.                            |
| data\[campaign]\[links]        | object   | Links related to the campaign.                                |
| data\[campaign]\[links]\[self] | string   | URL to fetch the campaign's details through the CMP Open API. |

### Example

```json
{
  "event_name": "campaign_metadata_modified",
  "data": {
    "campaign": {
      "id": "8q7f910551b00a722e0418830cee6612",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612"
      }
    }
  }
}
```

## campaign\_brief\_added

A brief was added to a campaign.

### Payload

| **Key**                         | **Type** | **Description**                                               |
| ------------------------------- | -------- | ------------------------------------------------------------- |
| event\_name                     | string   | Name of the event. The value is `campaign_brief_added`.       |
| data                            | object   | Data of the event.                                            |
| data\[campaign]                 | object   | Data of the campaign associated with the event.               |
| data\[campaign]\[id]            | string   | Unique identifier of the campaign.                            |
| data\[campaign]\[links]         | object   | Links related to the campaign.                                |
| data\[campaign]\[links]\[self]  | string   | URL to fetch the campaign's details through the CMP Open API. |
| data\[campaign]\[links]\[brief] | string   | URL to fetch the campaign's brief through the CMP Open API.   |

### Example

```json
{
  "event_name": "campaign_brief_added",
  "data": {
    "campaign": {
      "id": "8q7f910551b00a722e0418830cee6612",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612",
        "brief": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612/brief"
      }
    }
  }
}
```

## campaign\_brief\_removed

A campaign brief was removed.

### Payload

| **Key**                        | **Type** | **Description**                                               |
| ------------------------------ | -------- | ------------------------------------------------------------- |
| event\_name                    | string   | Name of the event. The value is `campaign_brief_removed`.     |
| data                           | object   | Data of the event.                                            |
| data\[campaign]                | object   | Data of the campaign associated with the event.               |
| data\[campaign]\[id]           | string   | Unique identifier of the campaign.                            |
| data\[campaign]\[links]        | object   | Links related to the campaign.                                |
| data\[campaign]\[links]\[self] | string   | URL to fetch the campaign's details through the CMP Open API. |

### Example

```json
{
  "event_name": "campaign_brief_removed",
  "data": {
    "campaign": {
      "id": "8q7f910551b00a722e0418830cee6612",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612"
      }
    }
  }
}
```

## campaign\_brief\_modified

A campaign brief was modified.

### Payload

| **Key**                         | **Type** | **Description**                                               |
| ------------------------------- | -------- | ------------------------------------------------------------- |
| event\_name                     | string   | Name of the event. The value is `campaign_brief_modified`.    |
| data                            | object   | Data of the event.                                            |
| data\[campaign]                 | object   | Data of the campaign associated with the event.               |
| data\[campaign]\[id]            | string   | Unique identifier of the campaign.                            |
| data\[campaign]\[links]         | object   | Links related to the campaign.                                |
| data\[campaign]\[links]\[self]  | string   | URL to fetch the campaign's details through the CMP Open API. |
| data\[campaign]\[links]\[brief] | string   | URL to fetch the campaign's brief through the CMP Open API.   |

### Example

```json
{
  "event_name": "campaign_brief_modified",
  "data": {
    "campaign": {
      "id": "8q7f910551b00a722e0418830cee6612",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612",
        "brief": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612/brief"
      }
    }
  }
}
```