Skip to main content
POST
/
v1
/
custom-kpi-datasets
/
{dataset_id}
/
campaigns
/
{campaign_id}
/
lock
Lock Campaign
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id}/lock', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "period_start": "2023-12-25",
  "period_end": "2023-12-25",
  "deadline": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "locked_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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

Response

Successful Response

Response schema for a single campaign.

id
string<uuid>
required

The campaign id.

dataset_id
string<uuid>
required

The parent dataset id.

name
string
required
period_start
string<date>
required
period_end
string<date>
required
deadline
string<date>
required
created_at
string<date-time>
required
locked_at
string<date-time>
created_by
string<uuid>
updated_by
string<uuid>
updated_at
string<date-time>