Skip to main content
PATCH
/
v1
/
custom-kpi-datasets
/
{dataset_id}
/
campaigns
/
{campaign_id}
/
assignments
/
{campaign_assignment_id}
/
values
Edit Campaign Assignment Values
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    values: [
      {
        kpi_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        value_numeric: 123,
        value_text: '<string>',
        value_date: '2023-12-25'
      }
    ],
    attachment_file_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id}/assignments/{campaign_assignment_id}/values', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assignment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "kpi_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "submitted_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "value_numeric": 123,
    "value_text": "<string>",
    "value_date": "2023-12-25",
    "submitter_email": "<string>",
    "submitter_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

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
campaign_assignment_id
string<uuid>
required

Body

application/json

Request schema for submitting or updating KPI values for an assignment.

values
ValueEntrySch · object[]
required
Required array length: 1 - 100 elements
attachment_file_ids
string<uuid>[]

If set, replaces the campaign-assignment's evidence pool with the given file IDs. If None, no attachment changes are made (legacy webhook behavior).

Maximum array length: 20

Response

Successful Response

id
string<uuid>
required

The assignment id.

assignment_id
string<uuid>
required

The assignment id.

kpi_id
string<uuid>
required
submitted_at
string<date-time>
required
created_at
string<date-time>
required
value_numeric
number
value_text
string
value_date
string<date>
submitter_email
string
submitter_user_id
string<uuid>