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

# Lock Campaign

> Lock a campaign to prevent further submissions

# Lock Campaign

Lock a campaign, preventing any further value submissions from recipients. Locked campaigns keep all existing data but reject new or edited values.

## 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 to lock
</ParamField>

## Response

Returns the campaign with `locked_at` set to the current timestamp (HTTP 200).

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

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

<ResponseField name="locked_at" type="string">
  Timestamp when the campaign was locked (ISO 8601). Now set.
</ResponseField>

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

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

<ResponseField name="deadline" type="string">
  Submission deadline.
</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 POST "https://api.dcycle.io/v1/custom-kpi-datasets/${DATASET_ID}/campaigns/${CAMPAIGN_ID}/lock" \
    -H "x-api-key: ${DCYCLE_API_KEY}" \
    -H "x-organization-id: ${DCYCLE_ORG_ID}"
  ```

  ```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"),
  }

  dataset_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  campaign_id = "b2c3d4e5-f6a7-8901-bcde-f12345678901"

  response = requests.post(
      f"https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id}/lock",
      headers=headers,
  )

  print(f"Locked at: {response.json()['locked_at']}")
  ```

  ```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,
  };

  const datasetId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';
  const campaignId = 'b2c3d4e5-f6a7-8901-bcde-f12345678901';

  axios.post(`https://api.dcycle.io/v1/custom-kpi-datasets/${datasetId}/campaigns/${campaignId}/lock`, null, { headers })
    .then(response => console.log(`Locked at: ${response.data.locked_at}`));
  ```
</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": "2025-06-20T16:00:00Z",
  "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-20T16: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"
}
```

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Unlock Campaign" icon="lock-open" href="/api-reference/custom-kpi/unlock-campaign">
    Re-open for submissions
  </Card>

  <Card title="Get Campaign" icon="magnifying-glass" href="/api-reference/custom-kpi/get-campaign">
    View campaign status
  </Card>
</CardGroup>