> ## 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.

# Update Campaign

> Update a campaign's name, dates, or deadline

# Update Campaign

Update the name, reporting period, or deadline of an existing campaign. Only send the fields you want to change.

## 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>

<ParamField path="campaign_id" type="string" required>
  UUID of the campaign
</ParamField>

### Body Parameters

All fields are optional.

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

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

<ParamField body="period_end" type="string">
  End of the reporting period. Must be after `period_start` when both are provided.
</ParamField>

<ParamField body="deadline" type="string">
  Submission deadline. Must be after `period_start` when both are provided.
</ParamField>

## Response

Returns the updated campaign (HTTP 200).

<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">
  Submission deadline (ISO 8601 date).
</ResponseField>

<ResponseField name="locked_at" type="string | null">
  Timestamp when the campaign was locked. `null` if still open.
</ResponseField>

<ResponseField name="created_at" type="datetime">
  Creation timestamp (ISO 8601).
</ResponseField>

<ResponseField name="updated_at" type="string | null">
  Last update timestamp (ISO 8601).
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -X PATCH "https://api.dcycle.io/v1/custom-kpi-datasets/${DATASET_ID}/campaigns/${CAMPAIGN_ID}" \
    -H "x-api-key: ${DCYCLE_API_KEY}" \
    -H "x-organization-id: ${DCYCLE_ORG_ID}" \
    -H "Content-Type: application/json" \
    -d '{"deadline": "2025-05-01", "name": "Q1 2025 Water Survey (Extended)"}'
  ```

  ```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"
  campaign_id = "b2c3d4e5-f6a7-8901-bcde-f12345678901"

  response = requests.patch(
      f"https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id}",
      headers=headers,
      json={"deadline": "2025-05-01", "name": "Q1 2025 Water Survey (Extended)"},
  )

  print(f"Updated: deadline → {response.json()['deadline']}")
  ```

  ```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';
  const campaignId = 'b2c3d4e5-f6a7-8901-bcde-f12345678901';

  axios.patch(`https://api.dcycle.io/v1/custom-kpi-datasets/${datasetId}/campaigns/${campaignId}`, {
    deadline: '2025-05-01',
    name: 'Q1 2025 Water Survey (Extended)',
  }, { headers })
  .then(response => console.log(`Updated: ${response.data.name}`));
  ```
</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 (Extended)",
  "period_start": "2025-01-01",
  "period_end": "2025-03-31",
  "deadline": "2025-05-01",
  "locked_at": null,
  "created_by": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "updated_by": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "created_at": "2025-06-15T10:00:00Z",
  "updated_at": "2025-06-18T14:00:00Z"
}
```

## 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"}
```

### 404 Not Found

**Cause:** Campaign not found

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "detail": "Campaign not found"
}
```

### 422 Validation Error

**Cause:** Invalid or missing required fields in the request body

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

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Get Campaign" icon="magnifying-glass" href="/api-reference/custom-kpi/get-campaign">
    View campaign with recipients
  </Card>

  <Card title="Lock Campaign" icon="lock" href="/api-reference/custom-kpi/lock-campaign">
    Prevent further submissions
  </Card>
</CardGroup>