Skip to main content
POST
/
v1
/
custom-kpi-datasets
/
{dataset_id}
/
campaigns
/
{campaign_id}
/
assignments
Add Campaign Recipient
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    data_owner_email: 'jsmith@example.com',
    facility_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    data_owner_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id}/assignments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "data_owner_email": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "facility_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "data_owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "last_invited_at": "2023-11-07T05:31:56Z",
  "status": "awaiting",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-organization-id
string
​
x-api-key
string
​
x-user-id
string

Path Parameters

​
dataset_id
string<uuid>
required
​
campaign_id
string<uuid>
required

Body

application/json

Request schema for creating a dataset assignment.

​
organization_id
string<uuid>
required

The assigned organization id.

​
data_owner_email
string<email>
required

The data owner email address.

​
facility_id
string<uuid>

The assigned facility id.

​
data_owner_user_id
string<uuid>

The data owner user id.

Response

Successful Response

Campaign-assignment with embedded dataset assignment + computed status.

​
id
string<uuid>
required
​
campaign_id
string<uuid>
required
​
assignment_id
string<uuid>
required
​
assignment
AssignmentSch · object
required

Dataset-scoped assignment row (contact info only).

​
created_at
string<date-time>
required
​
last_invited_at
string<date-time>
​
status
string
default:awaiting

Derived: awaiting | partial | completed | locked

​
updated_at
string<date-time>