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));import requests
url = "https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/assignments/{assignment_id}"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.delete(url, headers=headers)
print(response.text)curl --request DELETE \
--url https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/assignments/{assignment_id} \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'Delete Assignment
Remove a data owner assignment from a dataset
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));import requests
url = "https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/assignments/{assignment_id}"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.delete(url, headers=headers)
print(response.text)curl --request DELETE \
--url https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/assignments/{assignment_id} \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'← Custom KPI
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
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faPath Parameters
string
required
UUID of the parent dataset
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}"
import requests
import os
headers = {
"x-api-key": os.getenv("DCYCLE_API_KEY"),
"x-organization-id": os.getenv("DCYCLE_ORG_ID"),
}
dataset_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
assignment_id = "d4e5f6a7-b8c9-0123-defa-234567890123"
response = requests.delete(
f"https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/assignments/{assignment_id}",
headers=headers,
)
if response.status_code == 204:
print("Assignment deleted")
const axios = require('axios');
const headers = {
'x-api-key': process.env.DCYCLE_API_KEY,
'x-organization-id': process.env.DCYCLE_ORG_ID,
};
const datasetId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';
const assignmentId = 'd4e5f6a7-b8c9-0123-defa-234567890123';
axios.delete(
`https://api.dcycle.io/v1/custom-kpi-datasets/${datasetId}/assignments/${assignmentId}`,
{ headers }
)
.then(() => console.log('Assignment deleted'));
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"
}
Related Endpoints
Create Assignment
Assign a new data owner
List Assignments
View all assignments
Was this page helpful?