Skip to main content
DELETE
/
v1
/
custom-kpi-datasets
/
{dataset_id}
/
assignments
/
{assignment_id}
Delete Assignment
const options = {
  method: 'DELETE',
  headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};

fetch('https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/assignments/{assignment_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Delete Assignment

Remove a data owner assignment from a dataset. This only works if no campaign values have been submitted through this assignment.
This action cannot be undone. If the assignment has submitted values, the API returns 409 Conflict.

Request

Headers

x-api-key
string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
x-organization-id
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

dataset_id
string
required
UUID of the parent dataset
assignment_id
string
required
UUID of the assignment to delete

Response

Returns HTTP 204 No Content on success.

Example

curl -X DELETE "https://api.dcycle.io/v1/custom-kpi-datasets/${DATASET_ID}/assignments/${ASSIGNMENT_ID}" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

Common Errors

401 Unauthorized

Cause: Missing or invalid API key
{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}

403 Forbidden

Cause: The authenticated user is not a member of the organization
{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}

404 Not Found

Cause: Assignment not found
{
  "detail": "Assignment not found"
}

409 Conflict

Cause: Assignment has submitted values The assignment has submitted campaign values and cannot be deleted.
{
  "detail": "Assignment has submitted values"
}

Create Assignment

Assign a new data owner

List Assignments

View all assignments