> ## Documentation Index
> Fetch the complete documentation index at: https://code.dcycle.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Campaign

> Create a new data collection campaign within a dataset

# Create Campaign

Create a new campaign to collect KPI data from assigned data owners for a specific reporting period. Optionally link existing dataset assignments as recipients.

<Note>
  Creating a campaign does **not** send invite emails. Use [Send Invites](/api-reference/custom-kpi/send-invites) after creating the campaign to notify recipients.
</Note>

## Request

### Headers

<ParamField header="x-api-key" type="string" required>
  Your API key for authentication

  **Example:** `sk_live_1234567890abcdef`
</ParamField>

<ParamField header="x-organization-id" type="string" required>
  Your organization UUID

  **Example:** `a8315ef3-dd50-43f8-b7ce-d839e68d51fa`
</ParamField>

### Path Parameters

<ParamField path="dataset_id" type="string" required>
  UUID of the parent dataset
</ParamField>

### Body Parameters

<ParamField body="name" type="string" required>
  Campaign name (1–255 characters)

  **Example:** `"Q1 2025 Water Survey"`
</ParamField>

<ParamField body="period_start" type="string" required>
  Start of the reporting period (ISO date)

  **Example:** `"2025-01-01"`
</ParamField>

<ParamField body="period_end" type="string" required>
  End of the reporting period. Must be after `period_start`.

  **Example:** `"2025-03-31"`
</ParamField>

<ParamField body="deadline" type="string" required>
  Submission deadline. Must be after `period_start`.

  **Example:** `"2025-04-15"`
</ParamField>

<ParamField body="assignment_ids" type="array[string]">
  UUIDs of dataset assignments to include as campaign recipients. Omit to add recipients later via [Add Recipient](/api-reference/custom-kpi/add-campaign-recipient).
</ParamField>

## Response

Returns the created campaign with its campaign-assignments (HTTP 201). The response uses the same shape as [Get Campaign](/api-reference/custom-kpi/get-campaign).

<ResponseField name="id" type="string">
  Campaign UUID.
</ResponseField>

<ResponseField name="dataset_id" type="string">
  UUID of the parent dataset.
</ResponseField>

<ResponseField name="name" type="string">
  Campaign display name.
</ResponseField>

<ResponseField name="period_start" type="string">
  Data collection period start date (ISO 8601 date).
</ResponseField>

<ResponseField name="period_end" type="string">
  Data collection period end date (ISO 8601 date).
</ResponseField>

<ResponseField name="deadline" type="string">
  Deadline for recipients to submit responses (ISO 8601 date).
</ResponseField>

<ResponseField name="locked_at" type="string | null">
  Timestamp when the campaign was locked. `null` for newly created campaigns.
</ResponseField>

<ResponseField name="created_by" type="string | null">
  UUID of the user who created the campaign.
</ResponseField>

<ResponseField name="created_at" type="datetime">
  Timestamp when the campaign was created
</ResponseField>

<ResponseField name="updated_at" type="datetime | null">
  Timestamp when the campaign was last updated
</ResponseField>

<ResponseField name="campaign_assignments" type="array[object]">
  Recipients linked to this campaign. Empty if no `assignment_ids` were provided.

  <Expandable title="Campaign Assignment Object">
    <ResponseField name="id" type="string">
      Campaign-assignment UUID.
    </ResponseField>

    <ResponseField name="campaign_id" type="string">
      Parent campaign UUID.
    </ResponseField>

    <ResponseField name="assignment_id" type="string">
      Underlying dataset assignment UUID.
    </ResponseField>

    <ResponseField name="status" type="string">
      Derived status: `awaiting` (always for new campaigns).
    </ResponseField>

    <ResponseField name="assignment" type="object">
      Embedded dataset assignment with recipient details.

      <Expandable title="Assignment Object">
        <ResponseField name="data_owner_email" type="string">
          Email address of the recipient.
        </ResponseField>

        <ResponseField name="organization_id" type="string">
          Organization UUID the assignment targets.
        </ResponseField>

        <ResponseField name="facility_id" type="string | null">
          Facility UUID if the assignment is facility-scoped.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -X POST "https://api.dcycle.io/v1/custom-kpi-datasets/${DATASET_ID}/campaigns" \
    -H "x-api-key: ${DCYCLE_API_KEY}" \
    -H "x-organization-id: ${DCYCLE_ORG_ID}" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Q1 2025 Water Survey",
      "period_start": "2025-01-01",
      "period_end": "2025-03-31",
      "deadline": "2025-04-15",
      "assignment_ids": [
        "d4e5f6a7-b8c9-0123-defa-234567890123",
        "e5f6a7b8-c9d0-1234-efab-345678901234"
      ]
    }'
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import requests
  import os

  headers = {
      "x-api-key": os.getenv("DCYCLE_API_KEY"),
      "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
      "Content-Type": "application/json",
  }

  dataset_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

  response = requests.post(
      f"https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns",
      headers=headers,
      json={
          "name": "Q1 2025 Water Survey",
          "period_start": "2025-01-01",
          "period_end": "2025-03-31",
          "deadline": "2025-04-15",
          "assignment_ids": [
              "d4e5f6a7-b8c9-0123-defa-234567890123",
              "e5f6a7b8-c9d0-1234-efab-345678901234",
          ],
      },
  )

  campaign = response.json()
  print(f"Created: {campaign['name']} ({len(campaign['campaign_assignments'])} recipients)")
  ```

  ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const axios = require('axios');

  const headers = {
    'x-api-key': process.env.DCYCLE_API_KEY,
    'x-organization-id': process.env.DCYCLE_ORG_ID,
    'Content-Type': 'application/json',
  };

  const datasetId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';

  axios.post(`https://api.dcycle.io/v1/custom-kpi-datasets/${datasetId}/campaigns`, {
    name: 'Q1 2025 Water Survey',
    period_start: '2025-01-01',
    period_end: '2025-03-31',
    deadline: '2025-04-15',
    assignment_ids: [
      'd4e5f6a7-b8c9-0123-defa-234567890123',
      'e5f6a7b8-c9d0-1234-efab-345678901234',
    ],
  }, { headers })
  .then(response => console.log(`Created: ${response.data.id}`));
  ```
</CodeGroup>

### Successful Response

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "dataset_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Q1 2025 Water Survey",
  "period_start": "2025-01-01",
  "period_end": "2025-03-31",
  "deadline": "2025-04-15",
  "locked_at": null,
  "created_by": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "updated_by": null,
  "created_at": "2025-06-15T10:00:00Z",
  "updated_at": null,
  "campaign_assignments": [
    {
      "id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
      "campaign_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "assignment_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
      "last_invited_at": null,
      "completed_at": null,
      "status": "awaiting",
      "assignment": {
        "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
        "dataset_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
        "facility_id": null,
        "data_owner_user_id": null,
        "data_owner_email": "supplier@example.com",
        "created_at": "2025-06-10T08:00:00Z",
        "updated_at": null
      },
      "created_at": "2025-06-15T10:00:00Z",
      "updated_at": null
    }
  ]
}
```

## Common Errors

### 401 Unauthorized

**Cause:** Missing or invalid API key

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}
```

### 403 Forbidden

**Cause:** The authenticated user is not a member of the organization

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}
```

### 422 Validation Error

**Cause:** `period_end` is not after `period_start`

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "detail": [
    {
      "loc": ["body", "period_end"],
      "msg": "period_end must be after period_start",
      "type": "value_error"
    }
  ]
}
```

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Send Invites" icon="paper-plane" href="/api-reference/custom-kpi/send-invites">
    Send invite emails to recipients
  </Card>

  <Card title="List Campaigns" icon="list" href="/api-reference/custom-kpi/list-campaigns">
    View all campaigns
  </Card>
</CardGroup>