Create an organization design template (org admin)
import requests
url = "https://eu.app.clarifeye.ai/api/v1/organizations/{organization_id}/design-templates/"
payload = {
"enabled": True,
"all_stores": True,
"store_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"name": "<string>",
"when_to_use": "<string>",
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
all_stores: true,
store_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
name: '<string>',
when_to_use: '<string>',
notes: '<string>'
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/organizations/{organization_id}/design-templates/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/organizations/{organization_id}/design-templates/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"all_stores": true,
"store_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"name": "<string>",
"when_to_use": "<string>",
"notes": "<string>"
}
'{
"enabled": true,
"all_stores": true,
"store_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"name": "<string>",
"when_to_use": "<string>",
"output_format": "pdf",
"notes": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"linked_store_count": 123,
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"content_type": "<string>",
"checksum": "<string>",
"signed_url": "<string>"
}
]
}Organization items
Create an organization design template (org admin)
POST
/
organizations
/
{organization_id}
/
design-templates
/
Create an organization design template (org admin)
import requests
url = "https://eu.app.clarifeye.ai/api/v1/organizations/{organization_id}/design-templates/"
payload = {
"enabled": True,
"all_stores": True,
"store_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"name": "<string>",
"when_to_use": "<string>",
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
all_stores: true,
store_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
name: '<string>',
when_to_use: '<string>',
notes: '<string>'
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/organizations/{organization_id}/design-templates/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/organizations/{organization_id}/design-templates/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"all_stores": true,
"store_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"name": "<string>",
"when_to_use": "<string>",
"notes": "<string>"
}
'{
"enabled": true,
"all_stores": true,
"store_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"name": "<string>",
"when_to_use": "<string>",
"output_format": "pdf",
"notes": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"linked_store_count": 123,
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"content_type": "<string>",
"checksum": "<string>",
"signed_url": "<string>"
}
]
}Authorizations
BearerAuthTokenAuth
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Body
application/json
Response
201 - application/json
Created