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

# Add Campaign Recipient

> Add a data owner as a recipient to a campaign

# Add Campaign Recipient

Link a data owner to a campaign. If the data owner doesn't have an existing dataset assignment, one is created automatically.

<Note>
  Adding a recipient does **not** send an invite email. Use [Send Invites](/api-reference/custom-kpi/send-invites) (bulk) or [Resend Invite](/api-reference/custom-kpi/resend-invite) (individual) to notify them.
</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>

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

### Body Parameters

<ParamField body="organization_id" type="string" required>
  UUID of the organization this recipient belongs to
</ParamField>

<ParamField body="data_owner_email" type="string" required>
  Email address of the data owner

  **Example:** `"facility-manager@example.com"`
</ParamField>

<ParamField body="facility_id" type="string">
  UUID of a specific facility (omit for org-level)
</ParamField>

<ParamField body="data_owner_user_id" type="string">
  UUID of an existing Dcycle user
</ParamField>

## Response

Returns the campaign-assignment with embedded dataset assignment (HTTP 201).

<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="last_invited_at" type="string | null">
  When the invite email was last sent. `null` until [Send Invites](/api-reference/custom-kpi/send-invites) is called.
</ResponseField>

<ResponseField name="completed_at" type="string | null">
  When the recipient completed all KPIs. `null` if pending.
</ResponseField>

<ResponseField name="status" type="string">
  Derived status: `awaiting`, `completed`, or `locked`.
</ResponseField>

<ResponseField name="assignment" type="object">
  Embedded dataset assignment with recipient details (`data_owner_email`, `organization_id`, `facility_id`).
</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}/assignments" \
    -H "x-api-key: ${DCYCLE_API_KEY}" \
    -H "x-organization-id: ${DCYCLE_ORG_ID}" \
    -H "Content-Type: application/json" \
    -d '{
      "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
      "data_owner_email": "facility-manager@example.com"
    }'
  ```

  ```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.post(
      f"https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id}/assignments",
      headers=headers,
      json={
          "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
          "data_owner_email": "facility-manager@example.com",
      },
  )

  ca = response.json()
  print(f"Added recipient: {ca['assignment']['data_owner_email']} (status: {ca['status']})")
  ```

  ```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.post(`https://api.dcycle.io/v1/custom-kpi-datasets/${datasetId}/campaigns/${campaignId}/assignments`, {
    organization_id: 'a8315ef3-dd50-43f8-b7ce-d839e68d51fa',
    data_owner_email: 'facility-manager@example.com',
  }, { headers })
  .then(response => console.log(`Added: ${response.data.id}`));
  ```
</CodeGroup>

### Successful Response

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "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": "facility-manager@example.com",
    "created_at": "2025-06-18T16:00:00Z",
    "updated_at": null
  },
  "created_at": "2025-06-18T16: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"}
```

### 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="Send Invites" icon="paper-plane" href="/api-reference/custom-kpi/send-invites">
    Notify all pending recipients
  </Card>

  <Card title="Remove Recipient" icon="user-minus" href="/api-reference/custom-kpi/remove-campaign-recipient">
    Unlink a recipient
  </Card>
</CardGroup>