API 参考
每一个公开的 REST 操作,包含其参数、请求体、响应以及提供服务的主机。代码片段可复制;本页面不会发送任何请求。
| Host | Serves |
|---|---|
| https://api.prodantix.com | Flags and messaging |
| https://eu.api.prodantix.com | Event ingestion (EU) |
| https://eu.replay.prodantix.com | Session replay (EU) |
billing
List the plan catalogue
Every prodantix plan with its entitlements and prices, and the add-ons sold beside them: the ladder and the add-on areas the pricing page and the plan picker render. Public, and cacheable for five minutes.
Responses
The plan catalogue
{
"plans": [
{
"tier": "string",
"cycle": "string",
"trialDays": "integer",
"priced": "boolean",
"entitlements": "unknown"
}
],
"addOns": [
{
"addOnKey": "string",
"area?": "string | null",
"currency": "string",
"cycle": "string",
"grants": "unknown",
"kind": "string",
"priceCents": "integer",
"priced": "boolean",
"unit?": "string | null"
}
]
}The plan catalogue is unavailable
Try it
curl -X GET "https://api.prodantix.com/v1/plans"const response = await fetch('https://api.prodantix.com/v1/plans', {
method: 'GET',
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/plans'),
);response = requests.get(
"https://api.prodantix.com/v1/plans",
)List the AI models and their prices
Every model a workspace can pick for the AI add-on, with its price per million tokens of each kind in micro-dollars: the model's price plus the markup. Public, and cacheable for an hour.
Responses
The offered models and their prices
{
"markupPercent": "integer",
"models": [
{
"id": "string",
"displayName": "string",
"perMillion": {
"input": "integer",
"output": "integer",
"cacheWrite5m": "integer",
"cacheWrite1h": "integer",
"cacheRead": "integer"
}
}
]
}The model list has not loaded yet
Try it
curl -X GET "https://api.prodantix.com/v1/ai/models"const response = await fetch('https://api.prodantix.com/v1/ai/models', {
method: 'GET',
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/ai/models'),
);response = requests.get(
"https://api.prodantix.com/v1/ai/models",
)List the add-on catalogue
Every add-on the company can buy beside its tier: area bundles, single features and standalone add-ons, each per billing cycle with its price. Needs prodantix.billing.read.
Responses
200 The catalogue
{
"addOns": [
{
"addOnKey": "string",
"area?": "string | null",
"currency": "string",
"cycle": "string",
"grants": "unknown",
"kind": "string",
"priceCents": "integer",
"priced": "boolean",
"unit?": "string | null"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/company/add-ons" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/add-ons', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/company/add-ons'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/company/add-ons",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List the company's add-ons
The add-ons the company holds, with when a removed one ends. Needs prodantix.billing.read.
Responses
200 The held add-ons
Try it
curl -X GET "https://api.prodantix.com/v1/company/held-add-ons" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/held-add-ons', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/company/held-add-ons'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/company/held-add-ons",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Preview an add-on
What buying the add-on adds to the next invoice, and which held features of its area it replaces with their unused time credited. Needs prodantix.billing.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| addOnKey required | path | string | The add-on, as the catalogue names it |
| quantity | query | integer | How many units, for an add-on bought in units |
Responses
The preview
{
"amountDueMinor": "integer",
"currency": "string",
"replaces": []
}No such add-on in the catalogue
Try it
curl -X GET "https://api.prodantix.com/v1/company/add-ons/:addOnKey/preview" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/add-ons/:addOnKey/preview', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/company/add-ons/:addOnKey/preview'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/company/add-ons/:addOnKey/preview",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Buy an add-on
Adds the add-on to the company's subscription, prorated on the next invoice; a bundle replaces the area's held features. Refused with ADD_ON_ALREADY_HELD or ADD_ON_COVERED_BY_BUNDLE (409), ADD_ON_NO_PAYMENT_METHOD, ADD_ON_COMPANY_HALTED or ADD_ON_NEEDS_SUBSCRIPTION (402). Needs prodantix.billing.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| addOnKey required | path | string | The add-on, as the catalogue names it |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"quantity?": "integer | null"
}Responses
The held add-on
{
"addOnKey": "string",
"area?": "string | null",
"endsAt?": "string | null",
"kind": "string",
"quantity": "integer",
"source": "string"
}Refused: no card on file, the company's billing has stopped, or no subscription to add it to
No such add-on in the catalogue
Already held, or covered by a held bundle
Try it
curl -X POST "https://api.prodantix.com/v1/company/add-ons/:addOnKey" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"quantity":0}'const response = await fetch('https://api.prodantix.com/v1/company/add-ons/:addOnKey', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"quantity": 0
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/company/add-ons/:addOnKey'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"quantity":0}),
);response = requests.post(
"https://api.prodantix.com/v1/company/add-ons/:addOnKey",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"quantity":0},
)Remove an add-on
Removes the add-on at the end of the current period: the company keeps it until then and what was built with it is kept. Needs prodantix.billing.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| addOnKey required | path | string | The add-on, as the catalogue names it |
Responses
The held add-on
{
"addOnKey": "string",
"area?": "string | null",
"endsAt?": "string | null",
"kind": "string",
"quantity": "integer",
"source": "string"
}No such add-on in the catalogue
Try it
curl -X DELETE "https://api.prodantix.com/v1/company/add-ons/:addOnKey" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/add-ons/:addOnKey', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/company/add-ons/:addOnKey'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/company/add-ons/:addOnKey",
headers={"Authorization": f"Bearer {bearer_auth}"},
)analytics
List annotations
The project's annotations whose days overlap from to to, both YYYY-MM-DD and inclusive, at most 500 a page. Name a report to add that report's own annotations to the project's. For the next page, pass the last annotation's id as after.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the annotations belong to |
| reportId | query | string | A report whose own annotations are wanted too |
| from required | query | string | The first day, YYYY-MM-DD |
| to required | query | string | The last day, YYYY-MM-DD |
| limit | query | string | At most this many annotations, 1 to 500 (500 when absent) |
| after | query | string | The id of the last annotation of the page before |
Responses
The annotations, earliest first
{
"annotations": [
{
"id": "string",
"reportId?": "string | null",
"startsOn": "string",
"endsOn": "string",
"text": "string",
"tags": [],
"createdByName?": "string | null",
"createdAt": "string",
"updatedAt": "string",
"canChange": "boolean"
}
]
}The request does not describe an annotation
The caller may not do this
The project, report or annotation is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/annotations" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/annotations', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/annotations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/annotations",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add an annotation
Marks a day, or a range when endsOn is given, with a note of up to 200 characters and one to ten tags. With reportId it shows on that report only; without, on every chart in the project whose dates cover it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the annotations belong to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"reportId?": "string | null",
"startsOn": "string",
"endsOn?": "string | null",
"text": "string",
"tags": []
}Responses
The annotation as stored
{
"id": "string",
"reportId?": "string | null",
"startsOn": "string",
"endsOn": "string",
"text": "string",
"tags": [],
"createdByName?": "string | null",
"createdAt": "string",
"updatedAt": "string",
"canChange": "boolean"
}The request does not describe an annotation
The caller may not do this
The project, report or annotation is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/annotations" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"reportId":"string","startsOn":"string","endsOn":"string","text":"string","tags":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/annotations', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"reportId": "string",
"startsOn": "string",
"endsOn": "string",
"text": "string",
"tags": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/annotations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"reportId":"string","startsOn":"string","endsOn":"string","text":"string","tags":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/annotations",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"reportId":"string","startsOn":"string","endsOn":"string","text":"string","tags":[]},
)Change an annotation
Replaces an annotation's days, text, tags and where it shows. Open to its author and to holders of prodantix.annotations.write.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the annotations belong to |
| annotationId required | path | string | The annotation |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"reportId?": "string | null",
"startsOn": "string",
"endsOn?": "string | null",
"text": "string",
"tags": []
}Responses
The annotation as stored
{
"id": "string",
"reportId?": "string | null",
"startsOn": "string",
"endsOn": "string",
"text": "string",
"tags": [],
"createdByName?": "string | null",
"createdAt": "string",
"updatedAt": "string",
"canChange": "boolean"
}The request does not describe an annotation
The caller may not do this
The project, report or annotation is not there
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/annotations/:annotationId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"reportId":"string","startsOn":"string","endsOn":"string","text":"string","tags":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/annotations/:annotationId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"reportId": "string",
"startsOn": "string",
"endsOn": "string",
"text": "string",
"tags": []
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/annotations/:annotationId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"reportId":"string","startsOn":"string","endsOn":"string","text":"string","tags":[]}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/annotations/:annotationId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"reportId":"string","startsOn":"string","endsOn":"string","text":"string","tags":[]},
)Delete an annotation
Removes an annotation from every chart it shows on. Open to its author and to holders of prodantix.annotations.write.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the annotations belong to |
| annotationId required | path | string | The annotation |
Responses
Deleted
The request does not describe an annotation
The caller may not do this
The project, report or annotation is not there
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/annotations/:annotationId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/annotations/:annotationId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/annotations/:annotationId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/annotations/:annotationId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a report's public link
The report's public link while it is on: its address, the day it stops and when its report last ran. Answers 404 when no link is on.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| reportId required | path | string | The saved report |
Responses
The public link
{
"reportId": "string",
"token": "string",
"url": "string",
"createdAt": "string",
"expiresAt": "string",
"expiresOn": "string",
"ranAt?": "string | null"
}The request does not describe a share
The caller may not do this
The project or report is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Turn a report's public link on
Turns the link on until expiresOn, a YYYY-MM-DD day after today and at most 90 days ahead, or moves the stop day of the link that is on; the link stops as that day begins, in UTC. Anyone with the address can then read the report's last run, without its cohort. Every run of the report refreshes what the link shows.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| reportId required | path | string | The saved report |
Body
{
"expiresOn": "string"
}Responses
The public link
{
"reportId": "string",
"token": "string",
"url": "string",
"createdAt": "string",
"expiresAt": "string",
"expiresOn": "string",
"ranAt?": "string | null"
}The request does not describe a share
The caller may not do this
The project or report is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"expiresOn":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"expiresOn": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"expiresOn":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"expiresOn":"string"},
)Turn a report's public link off
Ends the link at once; its address answers 404 from then on.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| reportId required | path | string | The saved report |
Responses
Turned off
The request does not describe a share
The caller may not do this
The project or report is not there
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Send a report to teammates
Sends the report to between 1 and 20 members of the company, with an optional note of up to 1000 characters, by email and push. link is the console address the message opens, and must open this report; language is the sender's console language, which the email and push are written in.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| reportId required | path | string | The saved report |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"recipients": [],
"note?": "string | null",
"link": "string",
"language": "string"
}Responses
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/shares" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"recipients":[],"note":"string","link":"string","language":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/shares', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"recipients": [],
"note": "string",
"link": "string",
"language": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/shares'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"recipients":[],"note":"string","link":"string","language":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/shares",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"recipients":[],"note":"string","link":"string","language":"string"},
)Read a shared report
The report behind a public link, as it was last run. Needs no credential. Answers 404 alike for a link that was turned off, has stopped or never existed, and 429 past 60 reads a minute of one link or 30 from one address.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| token required | path | string | The link's token, from its address |
Responses
Try it
curl -X GET "https://api.prodantix.com/v1/shared-reports/:token"const response = await fetch('https://api.prodantix.com/v1/shared-reports/:token', {
method: 'GET',
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/shared-reports/:token'),
);response = requests.get(
"https://api.prodantix.com/v1/shared-reports/:token",
)Read a report endpoint
A saved report's current answer, for a customer's own backend to embed. Opened by the endpoint's token as a Bearer token, never a member session; the answer is computed at most once per the endpoint's cache window.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| endpointId required | path | string | The endpoint's id |
Responses
The report's answer
{
"reportId": "string",
"name": "string",
"kind": "string",
"result": "unknown",
"computedAt": "string"
}No token, or a token that does not open this endpoint
The report is an attribution, journey or score distribution report and its feature is no longer in the company's plan
Read more than 600 times in a minute
Try it
curl -X GET "https://api.prodantix.com/v1/endpoints/:endpointId"const response = await fetch('https://api.prodantix.com/v1/endpoints/:endpointId', {
method: 'GET',
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/endpoints/:endpointId'),
);response = requests.get(
"https://api.prodantix.com/v1/endpoints/:endpointId",
)List dashboard templates
The marketing boards a project can be given in one step: traffic sources, new contacts, score distribution, email performance, form performance, campaign performance and attribution, each with the report kinds on it that need their own permission and plan feature.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| language | query | string | The language of the names and descriptions, one of 18; English when absent or unknown |
Responses
The templates
{
"templates": [
{
"key": "string",
"name": "string",
"description": "string",
"kinds": []
}
]
}The caller may not read dashboards
Try it
curl -X GET "https://api.prodantix.com/v1/dashboard-templates" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/dashboard-templates', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/dashboard-templates'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/dashboard-templates",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a dashboard from a template
Creates an ordinary dashboard from a template, its tiles titled in the chosen language and reading the last 30 days. The score distribution board holds one tile per lead score for people. A second board from the same template takes a numbered name.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"templateKey": "string",
"language?": "string | null"
}Responses
The dashboard
{
"id": "string",
"name": "string",
"tiles": "unknown",
"createdAt": "string",
"updatedAt": "string"
}The plan holds no more dashboards, or lacks a report the template holds
The caller may not create dashboards, or read a report the template holds
No such project or template
The project has no lead score for people, or too many boards carry the template's name
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/dashboards/from-template" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"templateKey":"string","language":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/dashboards/from-template', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"templateKey": "string",
"language": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/dashboards/from-template'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"templateKey":"string","language":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/dashboards/from-template",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"templateKey":"string","language":"string"},
)List a report's comment threads
The report's threads, earliest first, at most 50 a page, each with its comments in order. For the next page, pass the last thread's id as after. A deleted comment keeps its place with no words, mentions or reactions.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| reportId required | path | string | The saved report |
| limit | query | integer | At most this many threads, 1 to 50 (50 when absent) |
| after | query | string | The id of the last thread of the page before |
Responses
The threads
{
"threads": [
{
"id": "string",
"reportId": "string",
"anchor?": {
"metric?": "string | null",
"bucket?": "string | null",
"breakdown?": [],
"step?": "integer | null",
"event?": "string | null",
"cohortBucket?": "string | null",
"period?": "integer | null",
"daysActive?": "integer | null",
"state?": "string | null"
},
"resolved": "boolean",
"resolvedAt?": "string | null",
"resolvedBySub?": "string | null",
"createdBySub": "string",
"createdAt": "string",
"comments": [
{
"id": "string",
"threadId": "string",
"body?": "string | null",
"mentions": [],
"authorSub": "string",
"authorName?": "string | null",
"createdAt": "string",
"editedAt?": "string | null",
"deleted": "boolean",
"canChange": "boolean",
"reactions": [
{
"emoji": "string",
"count": "integer",
"reactedByMe": "boolean"
}
]
}
],
"hiddenReplies": "integer"
}
]
}The request does not describe a comment
The caller may not do this
The project, report, thread or comment is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/comment-threads" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/comment-threads', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/comment-threads'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/comment-threads",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Start a comment thread
Starts a thread on the whole report, or on one point of it when anchor names the point. The body is 1 to 10,000 characters; mentions name up to 20 members of the company.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| reportId required | path | string | The saved report |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"body": "string",
"anchor?": {
"metric?": "string | null",
"bucket?": "string | null",
"breakdown?": [],
"step?": "integer | null",
"event?": "string | null",
"cohortBucket?": "string | null",
"period?": "integer | null",
"daysActive?": "integer | null",
"state?": "string | null"
},
"mentions?": []
}Responses
The thread as it now stands
{
"id": "string",
"reportId": "string",
"anchor?": {
"metric?": "string | null",
"bucket?": "string | null",
"breakdown?": [],
"step?": "integer | null",
"event?": "string | null",
"cohortBucket?": "string | null",
"period?": "integer | null",
"daysActive?": "integer | null",
"state?": "string | null"
},
"resolved": "boolean",
"resolvedAt?": "string | null",
"resolvedBySub?": "string | null",
"createdBySub": "string",
"createdAt": "string",
"comments": [
{
"id": "string",
"threadId": "string",
"body?": "string | null",
"mentions": [],
"authorSub": "string",
"authorName?": "string | null",
"createdAt": "string",
"editedAt?": "string | null",
"deleted": "boolean",
"canChange": "boolean",
"reactions": [
{
"emoji": "string",
"count": "integer",
"reactedByMe": "boolean"
}
]
}
],
"hiddenReplies": "integer"
}The request does not describe a comment
The caller may not do this
The project, report, thread or comment is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/comment-threads" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"body":"string","anchor":"string","mentions":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/comment-threads', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"body": "string",
"anchor": "string",
"mentions": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/comment-threads'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"body":"string","anchor":"string","mentions":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/comment-threads",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"body":"string","anchor":"string","mentions":[]},
)Reply to a comment thread
Adds a comment to the thread. A thread whose first comment was deleted takes no replies.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| threadId required | path | string | The comment thread |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"body": "string",
"mentions?": []
}Responses
The thread as it now stands
{
"id": "string",
"reportId": "string",
"anchor?": {
"metric?": "string | null",
"bucket?": "string | null",
"breakdown?": [],
"step?": "integer | null",
"event?": "string | null",
"cohortBucket?": "string | null",
"period?": "integer | null",
"daysActive?": "integer | null",
"state?": "string | null"
},
"resolved": "boolean",
"resolvedAt?": "string | null",
"resolvedBySub?": "string | null",
"createdBySub": "string",
"createdAt": "string",
"comments": [
{
"id": "string",
"threadId": "string",
"body?": "string | null",
"mentions": [],
"authorSub": "string",
"authorName?": "string | null",
"createdAt": "string",
"editedAt?": "string | null",
"deleted": "boolean",
"canChange": "boolean",
"reactions": [
{
"emoji": "string",
"count": "integer",
"reactedByMe": "boolean"
}
]
}
],
"hiddenReplies": "integer"
}The request does not describe a comment
The caller may not do this
The project, report, thread or comment is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/comments" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"body":"string","mentions":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/comments', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"body": "string",
"mentions": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/comments'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"body":"string","mentions":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/comments",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"body":"string","mentions":[]},
)Change a comment
Replaces the comment's words and mentions. Open to its author only.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| commentId required | path | string | The comment |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"body": "string",
"mentions?": []
}Responses
The thread as it now stands
{
"id": "string",
"reportId": "string",
"anchor?": {
"metric?": "string | null",
"bucket?": "string | null",
"breakdown?": [],
"step?": "integer | null",
"event?": "string | null",
"cohortBucket?": "string | null",
"period?": "integer | null",
"daysActive?": "integer | null",
"state?": "string | null"
},
"resolved": "boolean",
"resolvedAt?": "string | null",
"resolvedBySub?": "string | null",
"createdBySub": "string",
"createdAt": "string",
"comments": [
{
"id": "string",
"threadId": "string",
"body?": "string | null",
"mentions": [],
"authorSub": "string",
"authorName?": "string | null",
"createdAt": "string",
"editedAt?": "string | null",
"deleted": "boolean",
"canChange": "boolean",
"reactions": [
{
"emoji": "string",
"count": "integer",
"reactedByMe": "boolean"
}
]
}
],
"hiddenReplies": "integer"
}The request does not describe a comment
The caller may not do this
The project, report, thread or comment is not there
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/comments/:commentId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"body":"string","mentions":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/comments/:commentId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"body": "string",
"mentions": []
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/comments/:commentId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"body":"string","mentions":[]}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/comments/:commentId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"body":"string","mentions":[]},
)Delete a comment
Takes the comment's words back; the thread keeps its place for it. Open to its author only.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| commentId required | path | string | The comment |
Responses
The thread as it now stands
{
"id": "string",
"reportId": "string",
"anchor?": {
"metric?": "string | null",
"bucket?": "string | null",
"breakdown?": [],
"step?": "integer | null",
"event?": "string | null",
"cohortBucket?": "string | null",
"period?": "integer | null",
"daysActive?": "integer | null",
"state?": "string | null"
},
"resolved": "boolean",
"resolvedAt?": "string | null",
"resolvedBySub?": "string | null",
"createdBySub": "string",
"createdAt": "string",
"comments": [
{
"id": "string",
"threadId": "string",
"body?": "string | null",
"mentions": [],
"authorSub": "string",
"authorName?": "string | null",
"createdAt": "string",
"editedAt?": "string | null",
"deleted": "boolean",
"canChange": "boolean",
"reactions": [
{
"emoji": "string",
"count": "integer",
"reactedByMe": "boolean"
}
]
}
],
"hiddenReplies": "integer"
}The request does not describe a comment
The caller may not do this
The project, report, thread or comment is not there
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/comments/:commentId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/comments/:commentId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/comments/:commentId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/comments/:commentId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Resolve a comment thread
Marks the thread resolved by the caller. Resolving a resolved thread changes nothing.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| threadId required | path | string | The comment thread |
Responses
The thread as it now stands
{
"id": "string",
"reportId": "string",
"anchor?": {
"metric?": "string | null",
"bucket?": "string | null",
"breakdown?": [],
"step?": "integer | null",
"event?": "string | null",
"cohortBucket?": "string | null",
"period?": "integer | null",
"daysActive?": "integer | null",
"state?": "string | null"
},
"resolved": "boolean",
"resolvedAt?": "string | null",
"resolvedBySub?": "string | null",
"createdBySub": "string",
"createdAt": "string",
"comments": [
{
"id": "string",
"threadId": "string",
"body?": "string | null",
"mentions": [],
"authorSub": "string",
"authorName?": "string | null",
"createdAt": "string",
"editedAt?": "string | null",
"deleted": "boolean",
"canChange": "boolean",
"reactions": [
{
"emoji": "string",
"count": "integer",
"reactedByMe": "boolean"
}
]
}
],
"hiddenReplies": "integer"
}The request does not describe a comment
The caller may not do this
The project, report, thread or comment is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/resolution" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/resolution', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/resolution'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/resolution",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Reopen a comment thread
Opens a resolved thread again.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| threadId required | path | string | The comment thread |
Responses
The thread as it now stands
{
"id": "string",
"reportId": "string",
"anchor?": {
"metric?": "string | null",
"bucket?": "string | null",
"breakdown?": [],
"step?": "integer | null",
"event?": "string | null",
"cohortBucket?": "string | null",
"period?": "integer | null",
"daysActive?": "integer | null",
"state?": "string | null"
},
"resolved": "boolean",
"resolvedAt?": "string | null",
"resolvedBySub?": "string | null",
"createdBySub": "string",
"createdAt": "string",
"comments": [
{
"id": "string",
"threadId": "string",
"body?": "string | null",
"mentions": [],
"authorSub": "string",
"authorName?": "string | null",
"createdAt": "string",
"editedAt?": "string | null",
"deleted": "boolean",
"canChange": "boolean",
"reactions": [
{
"emoji": "string",
"count": "integer",
"reactedByMe": "boolean"
}
]
}
],
"hiddenReplies": "integer"
}The request does not describe a comment
The caller may not do this
The project, report, thread or comment is not there
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/resolution" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/resolution', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/resolution'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/resolution",
headers={"Authorization": f"Bearer {bearer_auth}"},
)React to a comment
Adds the caller's reaction. Each person reacts with each emoji once.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| commentId required | path | string | The comment |
| emoji required | path | string | One of the six reactions, percent-encoded: 👍 ❤️ 🎯 🎉 🤔 👀 |
Responses
The thread as it now stands
{
"id": "string",
"reportId": "string",
"anchor?": {
"metric?": "string | null",
"bucket?": "string | null",
"breakdown?": [],
"step?": "integer | null",
"event?": "string | null",
"cohortBucket?": "string | null",
"period?": "integer | null",
"daysActive?": "integer | null",
"state?": "string | null"
},
"resolved": "boolean",
"resolvedAt?": "string | null",
"resolvedBySub?": "string | null",
"createdBySub": "string",
"createdAt": "string",
"comments": [
{
"id": "string",
"threadId": "string",
"body?": "string | null",
"mentions": [],
"authorSub": "string",
"authorName?": "string | null",
"createdAt": "string",
"editedAt?": "string | null",
"deleted": "boolean",
"canChange": "boolean",
"reactions": [
{
"emoji": "string",
"count": "integer",
"reactedByMe": "boolean"
}
]
}
],
"hiddenReplies": "integer"
}The request does not describe a comment
The caller may not do this
The project, report, thread or comment is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/comments/:commentId/reactions/:emoji" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/comments/:commentId/reactions/:emoji', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/comments/:commentId/reactions/:emoji'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/comments/:commentId/reactions/:emoji",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Take back a reaction
Removes the caller's reaction.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the report belongs to |
| commentId required | path | string | The comment |
| emoji required | path | string | One of the six reactions, percent-encoded: 👍 ❤️ 🎯 🎉 🤔 👀 |
Responses
The thread as it now stands
{
"id": "string",
"reportId": "string",
"anchor?": {
"metric?": "string | null",
"bucket?": "string | null",
"breakdown?": [],
"step?": "integer | null",
"event?": "string | null",
"cohortBucket?": "string | null",
"period?": "integer | null",
"daysActive?": "integer | null",
"state?": "string | null"
},
"resolved": "boolean",
"resolvedAt?": "string | null",
"resolvedBySub?": "string | null",
"createdBySub": "string",
"createdAt": "string",
"comments": [
{
"id": "string",
"threadId": "string",
"body?": "string | null",
"mentions": [],
"authorSub": "string",
"authorName?": "string | null",
"createdAt": "string",
"editedAt?": "string | null",
"deleted": "boolean",
"canChange": "boolean",
"reactions": [
{
"emoji": "string",
"count": "integer",
"reactedByMe": "boolean"
}
]
}
],
"hiddenReplies": "integer"
}The request does not describe a comment
The caller may not do this
The project, report, thread or comment is not there
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/comments/:commentId/reactions/:emoji" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/comments/:commentId/reactions/:emoji', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/comments/:commentId/reactions/:emoji'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/comments/:commentId/reactions/:emoji",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List warehouse destinations
The project's warehouse destinations. The secret access key is never returned.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the destination belongs to |
Responses
200 The destinations
{
"destinations": [
{
"id": "string",
"kind": "string",
"bigquery?": {
"dataset": "string",
"tablePrefix?": "string",
"serviceAccount?": "string | null"
},
"snowflake?": {
"account": "string",
"user": "string",
"warehouse": "string",
"database": "string",
"schema": "string",
"tablePrefix?": "string",
"role?": "string | null"
},
"name": "string",
"endpoint": "string",
"bucket": "string",
"region": "string",
"prefix": "string",
"accessKeyId": "string",
"schedule": "string",
"format": "string",
"models": [],
"enabled": "boolean",
"startsAt": "string",
"createdAt": "string",
"updatedAt": "string",
"lastRunState?": "string | null",
"lastRunAt?": "string | null"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a warehouse destination
Checks the bucket by writing and deleting one small object under the prefix, then saves the destination; its first run is the hour after it is created.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the destination belongs to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"kind?": "string",
"bigquery?": {
"dataset": "string",
"tablePrefix?": "string",
"serviceAccount?": "string | null"
},
"snowflake?": {
"account": "string",
"user": "string",
"warehouse": "string",
"database": "string",
"schema": "string",
"tablePrefix?": "string",
"role?": "string | null"
},
"name": "string",
"endpoint?": "string",
"bucket?": "string",
"region?": "string",
"prefix?": "string",
"accessKeyId?": "string",
"secretAccessKey?": "string | null",
"schedule": "string",
"format": "string",
"models": [],
"enabled?": "boolean | null"
}Responses
The destination
{
"id": "string",
"kind": "string",
"bigquery?": {
"dataset": "string",
"tablePrefix?": "string",
"serviceAccount?": "string | null"
},
"snowflake?": {
"account": "string",
"user": "string",
"warehouse": "string",
"database": "string",
"schema": "string",
"tablePrefix?": "string",
"role?": "string | null"
},
"name": "string",
"endpoint": "string",
"bucket": "string",
"region": "string",
"prefix": "string",
"accessKeyId": "string",
"schedule": "string",
"format": "string",
"models": [],
"enabled": "boolean",
"startsAt": "string",
"createdAt": "string",
"updatedAt": "string",
"lastRunState?": "string | null",
"lastRunAt?": "string | null"
}The settings are invalid
Warehouse sync is not in the company's plan
The caller may not manage warehouse destinations
The bucket could not be written to with these credentials
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"kind":"string","bigquery":"string","snowflake":"string","name":"string","endpoint":"string","bucket":"string","region":"string","prefix":"string","accessKeyId":"string","secretAccessKey":"string","schedule":"string","format":"string","models":[],"enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"kind": "string",
"bigquery": "string",
"snowflake": "string",
"name": "string",
"endpoint": "string",
"bucket": "string",
"region": "string",
"prefix": "string",
"accessKeyId": "string",
"secretAccessKey": "string",
"schedule": "string",
"format": "string",
"models": [],
"enabled": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"kind":"string","bigquery":"string","snowflake":"string","name":"string","endpoint":"string","bucket":"string","region":"string","prefix":"string","accessKeyId":"string","secretAccessKey":"string","schedule":"string","format":"string","models":[],"enabled":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"kind":"string","bigquery":"string","snowflake":"string","name":"string","endpoint":"string","bucket":"string","region":"string","prefix":"string","accessKeyId":"string","secretAccessKey":"string","schedule":"string","format":"string","models":[],"enabled":true},
)Update a warehouse destination
Changes a destination. A new endpoint, bucket or access key needs the secret access key again, and is checked as on creation.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the destination belongs to |
| destinationId required | path | string | The destination's id |
Body
{
"kind?": "string",
"bigquery?": {
"dataset": "string",
"tablePrefix?": "string",
"serviceAccount?": "string | null"
},
"snowflake?": {
"account": "string",
"user": "string",
"warehouse": "string",
"database": "string",
"schema": "string",
"tablePrefix?": "string",
"role?": "string | null"
},
"name": "string",
"endpoint?": "string",
"bucket?": "string",
"region?": "string",
"prefix?": "string",
"accessKeyId?": "string",
"secretAccessKey?": "string | null",
"schedule": "string",
"format": "string",
"models": [],
"enabled?": "boolean | null"
}Responses
The destination
{
"id": "string",
"kind": "string",
"bigquery?": {
"dataset": "string",
"tablePrefix?": "string",
"serviceAccount?": "string | null"
},
"snowflake?": {
"account": "string",
"user": "string",
"warehouse": "string",
"database": "string",
"schema": "string",
"tablePrefix?": "string",
"role?": "string | null"
},
"name": "string",
"endpoint": "string",
"bucket": "string",
"region": "string",
"prefix": "string",
"accessKeyId": "string",
"schedule": "string",
"format": "string",
"models": [],
"enabled": "boolean",
"startsAt": "string",
"createdAt": "string",
"updatedAt": "string",
"lastRunState?": "string | null",
"lastRunAt?": "string | null"
}The settings are invalid
No such destination
The bucket could not be written to with these credentials
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"kind":"string","bigquery":"string","snowflake":"string","name":"string","endpoint":"string","bucket":"string","region":"string","prefix":"string","accessKeyId":"string","secretAccessKey":"string","schedule":"string","format":"string","models":[],"enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"kind": "string",
"bigquery": "string",
"snowflake": "string",
"name": "string",
"endpoint": "string",
"bucket": "string",
"region": "string",
"prefix": "string",
"accessKeyId": "string",
"secretAccessKey": "string",
"schedule": "string",
"format": "string",
"models": [],
"enabled": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"kind":"string","bigquery":"string","snowflake":"string","name":"string","endpoint":"string","bucket":"string","region":"string","prefix":"string","accessKeyId":"string","secretAccessKey":"string","schedule":"string","format":"string","models":[],"enabled":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"kind":"string","bigquery":"string","snowflake":"string","name":"string","endpoint":"string","bucket":"string","region":"string","prefix":"string","accessKeyId":"string","secretAccessKey":"string","schedule":"string","format":"string","models":[],"enabled":true},
)Delete a warehouse destination
Stops the sync and deletes the destination's run history. Files already written stay in the bucket.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the destination belongs to |
| destinationId required | path | string | The destination's id |
Responses
Deleted
No such destination
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List a destination's runs
The latest 200 runs, newest interval first, with their state, rows and bytes written, and the provider's error when one failed.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the destination belongs to |
| destinationId required | path | string | The destination's id |
Responses
200 The runs
{
"runs": [
{
"id": "string",
"model": "string",
"intervalStart": "string",
"intervalEnd": "string",
"state": "string",
"attempts": "integer",
"rowsWritten?": "integer | null",
"bytesWritten?": "integer | null",
"failure?": "string | null"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId/runs" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId/runs', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId/runs'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId/runs",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Backfill a destination
Opens a run for every interval between from and to, oldest first, beside the schedule; a failed run in the range runs again. At most 2000 runs at once.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the destination belongs to |
| destinationId required | path | string | The destination's id |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"from": "string",
"to": "string"
}Responses
How many runs were opened
{
"opened": "integer"
}The range is invalid or too long
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId/backfill" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"from":"string","to":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId/backfill', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"from": "string",
"to": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId/backfill'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"from":"string","to":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId/backfill",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"from":"string","to":"string"},
)List warehouse sources
The outside data a project loads beside its events: S3 files, Stripe objects or Postgres tables, each table with its last run. Secrets are sealed and never returned.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the source belongs to |
Responses
The sources
{
"sources": [
{
"source": "string",
"views": "integer",
"visitors": "integer"
}
]
}Warehouse sources are not in the company's plan
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/warehouse/sources" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/sources",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a warehouse source
Adds an S3-compatible bucket, a Stripe account or a Postgres database a project loads from, hourly or daily. The secret is sealed on arrival.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the source belongs to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"kind?": "string",
"name": "string",
"endpoint?": "string",
"bucket?": "string",
"region?": "string",
"accessKeyId?": "string",
"host?": "string",
"port?": "integer",
"database?": "string",
"user?": "string",
"secretAccessKey?": "string | null",
"schedule?": "string",
"enabled?": "boolean | null"
}Responses
The source
{
"id": "string",
"kind": "string",
"name": "string",
"slug": "string",
"endpoint": "string",
"bucket": "string",
"region": "string",
"accessKeyId": "string",
"host": "string",
"port": "integer",
"database": "string",
"user": "string",
"schedule": "string",
"enabled": "boolean",
"nextRunAt": "string",
"tables": [
{
"id": "string",
"name": "string",
"sqlName": "string",
"prefix": "string",
"format": "string",
"object?": "string | null",
"sourceTable?": "string | null",
"lastRun?": {
"state": "string",
"rows?": "integer | null",
"bytes?": "integer | null",
"failure?": "string | null",
"startedAt": "string",
"finishedAt?": "string | null"
}
}
]
}The settings are invalid, or the name is taken
Warehouse sources are not in the company's plan
The caller may not manage the warehouse
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/warehouse/sources" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"kind":"string","name":"string","endpoint":"string","bucket":"string","region":"string","accessKeyId":"string","host":"string","port":0,"database":"string","user":"string","secretAccessKey":"string","schedule":"string","enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"kind": "string",
"name": "string",
"endpoint": "string",
"bucket": "string",
"region": "string",
"accessKeyId": "string",
"host": "string",
"port": 0,
"database": "string",
"user": "string",
"secretAccessKey": "string",
"schedule": "string",
"enabled": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"kind":"string","name":"string","endpoint":"string","bucket":"string","region":"string","accessKeyId":"string","host":"string","port":0,"database":"string","user":"string","secretAccessKey":"string","schedule":"string","enabled":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/sources",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"kind":"string","name":"string","endpoint":"string","bucket":"string","region":"string","accessKeyId":"string","host":"string","port":0,"database":"string","user":"string","secretAccessKey":"string","schedule":"string","enabled":true},
)Update a warehouse source
Renames a source, changes its connection or schedule, or switches it on or off. An absent secret keeps the stored one; the kind is fixed once made.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the source belongs to |
| sourceId required | path | string | The source's id |
Body
{
"kind?": "string",
"name": "string",
"endpoint?": "string",
"bucket?": "string",
"region?": "string",
"accessKeyId?": "string",
"host?": "string",
"port?": "integer",
"database?": "string",
"user?": "string",
"secretAccessKey?": "string | null",
"schedule?": "string",
"enabled?": "boolean | null"
}Responses
The source
{
"id": "string",
"kind": "string",
"name": "string",
"slug": "string",
"endpoint": "string",
"bucket": "string",
"region": "string",
"accessKeyId": "string",
"host": "string",
"port": "integer",
"database": "string",
"user": "string",
"schedule": "string",
"enabled": "boolean",
"nextRunAt": "string",
"tables": [
{
"id": "string",
"name": "string",
"sqlName": "string",
"prefix": "string",
"format": "string",
"object?": "string | null",
"sourceTable?": "string | null",
"lastRun?": {
"state": "string",
"rows?": "integer | null",
"bytes?": "integer | null",
"failure?": "string | null",
"startedAt": "string",
"finishedAt?": "string | null"
}
}
]
}The settings are invalid
No such source
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"kind":"string","name":"string","endpoint":"string","bucket":"string","region":"string","accessKeyId":"string","host":"string","port":0,"database":"string","user":"string","secretAccessKey":"string","schedule":"string","enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"kind": "string",
"name": "string",
"endpoint": "string",
"bucket": "string",
"region": "string",
"accessKeyId": "string",
"host": "string",
"port": 0,
"database": "string",
"user": "string",
"secretAccessKey": "string",
"schedule": "string",
"enabled": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"kind":"string","name":"string","endpoint":"string","bucket":"string","region":"string","accessKeyId":"string","host":"string","port":0,"database":"string","user":"string","secretAccessKey":"string","schedule":"string","enabled":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"kind":"string","name":"string","endpoint":"string","bucket":"string","region":"string","accessKeyId":"string","host":"string","port":0,"database":"string","user":"string","secretAccessKey":"string","schedule":"string","enabled":true},
)Delete a warehouse source
Removes a source and drops every table it loaded.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the source belongs to |
| sourceId required | path | string | The source's id |
Responses
Deleted
No such source
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add a table to a warehouse source
Loads every file under a prefix in one format, one Stripe object, or one Postgres table into a table the project's SQL reads. At most 20 tables per source.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the source belongs to |
| sourceId required | path | string | The source's id |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"prefix?": "string",
"format?": "string",
"object?": "string | null",
"sourceSchema?": "string | null",
"sourceTable?": "string | null"
}Responses
The source
{
"id": "string",
"kind": "string",
"name": "string",
"slug": "string",
"endpoint": "string",
"bucket": "string",
"region": "string",
"accessKeyId": "string",
"host": "string",
"port": "integer",
"database": "string",
"user": "string",
"schedule": "string",
"enabled": "boolean",
"nextRunAt": "string",
"tables": [
{
"id": "string",
"name": "string",
"sqlName": "string",
"prefix": "string",
"format": "string",
"object?": "string | null",
"sourceTable?": "string | null",
"lastRun?": {
"state": "string",
"rows?": "integer | null",
"bytes?": "integer | null",
"failure?": "string | null",
"startedAt": "string",
"finishedAt?": "string | null"
}
}
]
}The table is invalid, its name is taken, or the source already loads 20
No such source
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/tables" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","prefix":"string","format":"string","object":"string","sourceSchema":"string","sourceTable":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/tables', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"prefix": "string",
"format": "string",
"object": "string",
"sourceSchema": "string",
"sourceTable": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/tables'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","prefix":"string","format":"string","object":"string","sourceSchema":"string","sourceTable":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/tables",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","prefix":"string","format":"string","object":"string","sourceSchema":"string","sourceTable":"string"},
)Remove a table from a warehouse source
Stops loading the table and drops what it loaded.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the source belongs to |
| sourceId required | path | string | The source's id |
| tableId required | path | string | The table's id |
Responses
The source
{
"id": "string",
"kind": "string",
"name": "string",
"slug": "string",
"endpoint": "string",
"bucket": "string",
"region": "string",
"accessKeyId": "string",
"host": "string",
"port": "integer",
"database": "string",
"user": "string",
"schedule": "string",
"enabled": "boolean",
"nextRunAt": "string",
"tables": [
{
"id": "string",
"name": "string",
"sqlName": "string",
"prefix": "string",
"format": "string",
"object?": "string | null",
"sourceTable?": "string | null",
"lastRun?": {
"state": "string",
"rows?": "integer | null",
"bytes?": "integer | null",
"failure?": "string | null",
"startedAt": "string",
"finishedAt?": "string | null"
}
}
]
}No such source
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/tables/:tableId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/tables/:tableId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/tables/:tableId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/tables/:tableId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Run a warehouse source now
Loads the source's tables on the next pass, within a minute, beside its schedule.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the source belongs to |
| sourceId required | path | string | The source's id |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The source
{
"id": "string",
"kind": "string",
"name": "string",
"slug": "string",
"endpoint": "string",
"bucket": "string",
"region": "string",
"accessKeyId": "string",
"host": "string",
"port": "integer",
"database": "string",
"user": "string",
"schedule": "string",
"enabled": "boolean",
"nextRunAt": "string",
"tables": [
{
"id": "string",
"name": "string",
"sqlName": "string",
"prefix": "string",
"format": "string",
"object?": "string | null",
"sourceTable?": "string | null",
"lastRun?": {
"state": "string",
"rows?": "integer | null",
"bytes?": "integer | null",
"failure?": "string | null",
"startedAt": "string",
"finishedAt?": "string | null"
}
}
]
}No such source
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/run" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/run', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/run'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/run",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List warehouse models
The saved SQL a project reads as tables beside its events and sources, each with its last run.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the model belongs to |
Responses
The models
{
"models": [
{
"id": "string",
"name": "string",
"slug": "string",
"kind": "string",
"sql": "string",
"sqlName": "string",
"schedule": "string",
"enabled": "boolean",
"nextRunAt": "string",
"lastRun?": {
"state": "string",
"rows?": "integer | null",
"bytes?": "integer | null",
"failure?": "string | null",
"startedAt": "string",
"finishedAt?": "string | null"
}
}
]
}The data warehouse is not in the company's plan
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/warehouse/models" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/models', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/models'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/models",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a warehouse model
Saves SQL as a view, computed on every read, or a table, refreshed hourly or daily. The SQL is first run as the project, so what the project may not read is refused. At most 50 per project.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the model belongs to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"sql": "string",
"kind?": "string",
"schedule?": "string",
"enabled?": "boolean | null"
}Responses
The model
{
"id": "string",
"name": "string",
"slug": "string",
"kind": "string",
"sql": "string",
"sqlName": "string",
"schedule": "string",
"enabled": "boolean",
"nextRunAt": "string",
"lastRun?": {
"state": "string",
"rows?": "integer | null",
"bytes?": "integer | null",
"failure?": "string | null",
"startedAt": "string",
"finishedAt?": "string | null"
}
}The SQL or settings are invalid, the name is taken, or the project already holds 50
The data warehouse is not in the company's plan
The caller may not manage the warehouse
The company's hourly SQL budget is spent
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/warehouse/models" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","sql":"string","kind":"string","schedule":"string","enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/models', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"sql": "string",
"kind": "string",
"schedule": "string",
"enabled": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/models'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","sql":"string","kind":"string","schedule":"string","enabled":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/models",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","sql":"string","kind":"string","schedule":"string","enabled":true},
)Update a warehouse model
Renames a model, changes its SQL or schedule, or switches it on or off. Changed SQL is run as the project first, and a table refreshes within a minute.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the model belongs to |
| modelId required | path | string | The model's id |
Body
{
"name": "string",
"sql": "string",
"kind?": "string",
"schedule?": "string",
"enabled?": "boolean | null"
}Responses
The model
{
"id": "string",
"name": "string",
"slug": "string",
"kind": "string",
"sql": "string",
"sqlName": "string",
"schedule": "string",
"enabled": "boolean",
"nextRunAt": "string",
"lastRun?": {
"state": "string",
"rows?": "integer | null",
"bytes?": "integer | null",
"failure?": "string | null",
"startedAt": "string",
"finishedAt?": "string | null"
}
}The SQL or settings are invalid
No such model
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","sql":"string","kind":"string","schedule":"string","enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"sql": "string",
"kind": "string",
"schedule": "string",
"enabled": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","sql":"string","kind":"string","schedule":"string","enabled":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","sql":"string","kind":"string","schedule":"string","enabled":true},
)Delete a warehouse model
Removes a model and drops its view or table.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the model belongs to |
| modelId required | path | string | The model's id |
Responses
Deleted
No such model
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List a warehouse model's runs
A table model's last 20 refreshes, newest first.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the model belongs to |
| modelId required | path | string | The model's id |
Responses
The runs
{
"runs": [
{
"state": "string",
"rows?": "integer | null",
"bytes?": "integer | null",
"failure?": "string | null",
"startedAt": "string",
"finishedAt?": "string | null"
}
]
}No such model
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId/runs" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId/runs', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId/runs'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId/runs",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Refresh a warehouse model now
Refreshes a table model on the next pass, within a minute, beside its schedule. A view has no run.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the model belongs to |
| modelId required | path | string | The model's id |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The model
{
"id": "string",
"name": "string",
"slug": "string",
"kind": "string",
"sql": "string",
"sqlName": "string",
"schedule": "string",
"enabled": "boolean",
"nextRunAt": "string",
"lastRun?": {
"state": "string",
"rows?": "integer | null",
"bytes?": "integer | null",
"failure?": "string | null",
"startedAt": "string",
"finishedAt?": "string | null"
}
}The model is a view
No such model
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId/run" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId/run', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId/run'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId/run",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Preview a warehouse model
Runs a model's SQL as the project and answers its first 20 rows; nothing is saved.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the model belongs to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"sql": "string"
}Responses
The first rows
{
"columns": [
{
"name": "string",
"type": "string"
}
],
"rows": [],
"rowsRead": "integer",
"elapsedMs": "integer",
"truncated": "boolean"
}The SQL is invalid or reads what the project may not
The data warehouse is not in the company's plan
The company's hourly SQL budget is spent
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/warehouse/models/preview" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"sql":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/warehouse/models/preview', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"sql": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/warehouse/models/preview'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"sql":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/warehouse/models/preview",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"sql":"string"},
)Run SQL
Runs read-only ClickHouse SQL over the project's events and cohort memberships. ClickHouse itself keeps the query inside the project; it may run 30 seconds and return 100000 rows.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project to query |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"sql": "string"
}Responses
The rows
{
"columns": [
{
"name": "string",
"type": "string"
}
],
"rows": [],
"rowsRead": "integer",
"elapsedMs": "integer",
"truncated": "boolean"
}The SQL is invalid
Raw SQL is not in the company's plan
The caller may not run SQL, or the SQL reads outside the project
No such project
The query ran past its time, memory or the company's hourly quota
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/sql" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"sql":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/sql', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"sql": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/sql'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"sql":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/sql",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"sql":"string"},
)people
List property definitions
The definitions of a project's people, or of one company type, ordered by label.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
| includeArchived | query | string | true to list archived definitions too |
Responses
List property definitions
{
"definitions": [
{
"id": "string",
"object": "string",
"groupType": "string",
"name": "string",
"type": "string",
"validation": "unknown",
"label": "string",
"description": "string",
"groupId?": "string | null",
"requiredActions": [],
"calculated?": "unknown",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt?": "string | null",
"sensitive": "boolean",
"builtIn": "boolean"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/definitions" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/definitions', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/definitions'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/definitions",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Define a property
A property's type, validation, label, group, required actions and, for a calculated property, its calculation. Every later write is checked against it. Needs prodantix.properties.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"name": "string",
"type": "string",
"validation?": "unknown",
"label": "string",
"description?": "string",
"groupId?": "string | null",
"requiredActions?": [],
"calculated?": "unknown",
"sensitive?": "boolean"
}Responses
Define a property
{
"id": "string",
"object": "string",
"groupType": "string",
"name": "string",
"type": "string",
"validation": "unknown",
"label": "string",
"description": "string",
"groupId?": "string | null",
"requiredActions": [],
"calculated?": "unknown",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt?": "string | null",
"sensitive": "boolean",
"builtIn": "boolean"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/definitions" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","name":"string","type":"string","validation":"string","label":"string","description":"string","groupId":"string","requiredActions":[],"calculated":"string","sensitive":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/definitions', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"name": "string",
"type": "string",
"validation": "string",
"label": "string",
"description": "string",
"groupId": "string",
"requiredActions": [],
"calculated": "string",
"sensitive": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/definitions'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","name":"string","type":"string","validation":"string","label":"string","description":"string","groupId":"string","requiredActions":[],"calculated":"string","sensitive":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/definitions",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","name":"string","type":"string","validation":"string","label":"string","description":"string","groupId":"string","requiredActions":[],"calculated":"string","sensitive":true},
)Change a property definition
Rewrites everything but the name, the object and the type.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| definitionId required | path | string | The property definition |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"name": "string",
"type": "string",
"validation?": "unknown",
"label": "string",
"description?": "string",
"groupId?": "string | null",
"requiredActions?": [],
"calculated?": "unknown",
"sensitive?": "boolean"
}Responses
Change a property definition
{
"id": "string",
"object": "string",
"groupType": "string",
"name": "string",
"type": "string",
"validation": "unknown",
"label": "string",
"description": "string",
"groupId?": "string | null",
"requiredActions": [],
"calculated?": "unknown",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt?": "string | null",
"sensitive": "boolean",
"builtIn": "boolean"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/crm/definitions/:definitionId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","name":"string","type":"string","validation":"string","label":"string","description":"string","groupId":"string","requiredActions":[],"calculated":"string","sensitive":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/definitions/:definitionId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"name": "string",
"type": "string",
"validation": "string",
"label": "string",
"description": "string",
"groupId": "string",
"requiredActions": [],
"calculated": "string",
"sensitive": true
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/definitions/:definitionId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","name":"string","type":"string","validation":"string","label":"string","description":"string","groupId":"string","requiredActions":[],"calculated":"string","sensitive":true}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/crm/definitions/:definitionId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","name":"string","type":"string","validation":"string","label":"string","description":"string","groupId":"string","requiredActions":[],"calculated":"string","sensitive":true},
)Archive or restore a property definition
An archived definition stops checking values and leaves the Details tab; the values stay on the records.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| definitionId required | path | string | The property definition |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"archived": "boolean"
}Responses
Archive or restore a property definition
{
"id": "string",
"object": "string",
"groupType": "string",
"name": "string",
"type": "string",
"validation": "unknown",
"label": "string",
"description": "string",
"groupId?": "string | null",
"requiredActions": [],
"calculated?": "unknown",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt?": "string | null",
"sensitive": "boolean",
"builtIn": "boolean"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/definitions/:definitionId/archive" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"archived":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/definitions/:definitionId/archive', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"archived": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/definitions/:definitionId/archive'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"archived":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/definitions/:definitionId/archive",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"archived":true},
)Mark a built-in property sensitive
Marks a built-in property ($email, $phone and the rest) sensitive or not, so only members allowed to see sensitive values read it. Needs prodantix.properties.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"object": "string",
"groupType?": "string",
"property": "string",
"sensitive": "boolean"
}Responses
Mark a built-in property sensitive
{
"id": "string",
"object": "string",
"groupType": "string",
"name": "string",
"type": "string",
"validation": "unknown",
"label": "string",
"description": "string",
"groupId?": "string | null",
"requiredActions": [],
"calculated?": "unknown",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt?": "string | null",
"sensitive": "boolean",
"builtIn": "boolean"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/built-in-properties/sensitive" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","property":"string","sensitive":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/built-in-properties/sensitive', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"property": "string",
"sensitive": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/built-in-properties/sensitive'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","property":"string","sensitive":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/built-in-properties/sensitive",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","property":"string","sensitive":true},
)Read refused and undefined properties
Every value a definition refused, counted per property and rule with the last one seen, and every property no definition describes, with up to twenty sample values and the type a definition would take from them.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
| importId | query | string | An import's id, to read only the values that import's rows had refused |
Responses
Read refused and undefined properties
{
"drops": [
{
"name": "string",
"reason": "string",
"count": "integer",
"lastSeenAt": "string",
"lastValue": "string"
}
],
"undefined": [
{
"name": "string",
"count": "integer",
"lastSeenAt": "string",
"samples": [],
"suggestedType": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/data-quality" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/data-quality', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/data-quality'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/data-quality",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List property groups
The sections of a record's Details tab, in order.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
Responses
List property groups
{
"groups": [
{
"id": "string",
"name": "string",
"position": "integer"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/groups" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/groups', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/groups'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/groups",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add a property group
Adds a section after the last one.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"name": "string"
}Responses
Add a property group
{
"id": "string",
"name": "string",
"position": "integer"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/groups" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","name":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/groups', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"name": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/groups'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","name":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/groups",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","name":"string"},
)Rename a property group
Renames a section of the Details tab.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| groupId required | path | string | The property group |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string"
}Responses
Rename a property group
{
"id": "string",
"name": "string",
"position": "integer"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/crm/groups/:groupId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/groups/:groupId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string"
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/groups/:groupId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string"}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/crm/groups/:groupId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string"},
)Delete a property group
Deletes a section; its properties stay, in no section.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| groupId required | path | string | The property group |
Responses
Delete a property group
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/groups/:groupId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/groups/:groupId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/groups/:groupId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/groups/:groupId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Order property groups
Orders the sections as ids lists them.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"object": "string",
"groupType?": "string",
"ids": []
}Responses
Order property groups
{
"groups": [
{
"id": "string",
"name": "string",
"position": "integer"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/group-order" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","ids":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/group-order', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"ids": []
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/group-order'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","ids":[]}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/group-order",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","ids":[]},
)Save a record
Writes and clears a person's or a company's values, checked against the definitions and the required rules, as the caller, and answers the record once the write has landed, with refused naming each value left as it was and the rule it broke; the rest of the save stands. folded false means it had not landed within five seconds: read the record again. Needs prodantix.users.write.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"record": {
"object": "string",
"groupType?": "string",
"subject": "string"
},
"set?": "object",
"unset?": []
}Responses
Save a record
{
"eventId": "string",
"folded": "boolean",
"properties?": "object | null",
"refused": [
{
"field": "string",
"rule": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/records/save" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"record":"string","set":{},"unset":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/records/save', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"record": "string",
"set": {},
"unset": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/records/save'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"record":"string","set":{},"unset":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/records/save",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"record":"string","set":{},"unset":[]},
)Edit records in bulk
Sets or clears one property, the owner included, on up to 1000 people or companies of one type. The change is checked once; progress arrives as crmChange frames for the answered jobId.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"records": [
{
"object": "string",
"groupType?": "string",
"subject": "string"
}
],
"key": "string",
"value?": "unknown",
"clear?": "boolean"
}Responses
Edit records in bulk
{
"jobId": "string",
"total": "integer"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/records/bulk" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"records":[],"key":"string","value":"string","clear":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/records/bulk', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"records": [],
"key": "string",
"value": "string",
"clear": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/records/bulk'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"records":[],"key":"string","value":"string","clear":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/records/bulk",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"records":[],"key":"string","value":"string","clear":true},
)List association labels
A company type's labels for a person's link to a company, in order.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| groupType required | query | string | The company type |
Responses
List association labels
{
"labels": [
{
"id": "string",
"groupType": "string",
"name": "string",
"position": "integer"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/labels" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/labels', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/labels'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/labels",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add an association label
Adds a label after the company type's last one.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"groupType": "string",
"name": "string"
}Responses
Add an association label
{
"id": "string",
"groupType": "string",
"name": "string",
"position": "integer"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/labels" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"groupType":"string","name":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/labels', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"groupType": "string",
"name": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/labels'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"groupType":"string","name":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/labels",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"groupType":"string","name":"string"},
)Rename an association label
Renames a label everywhere it is on.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| labelId required | path | string | The association label |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string"
}Responses
Rename an association label
{
"id": "string",
"groupType": "string",
"name": "string",
"position": "integer"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/crm/labels/:labelId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/labels/:labelId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string"
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/labels/:labelId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string"}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/crm/labels/:labelId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string"},
)Delete an association label
Deletes a label and takes it off every link it was on.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| labelId required | path | string | The association label |
Responses
Delete an association label
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/labels/:labelId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/labels/:labelId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/labels/:labelId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/labels/:labelId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Order association labels
Orders a company type's labels as ids lists them.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"groupType": "string",
"ids": []
}Responses
Order association labels
{
"labels": [
{
"id": "string",
"groupType": "string",
"name": "string",
"position": "integer"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/label-order" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"groupType":"string","ids":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/label-order', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"groupType": "string",
"ids": []
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/label-order'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"groupType":"string","ids":[]}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/label-order",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"groupType":"string","ids":[]},
)Read the labels on links
The labels on a person's links (distinctId) or on a company's (groupType and groupKey).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| distinctId | query | string | The person |
| groupType | query | string | The company type |
| groupKey | query | string | The company |
Responses
Read the labels on links
{
"links": [
{
"distinctId": "string",
"groupType": "string",
"groupKey": "string",
"labelId": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/link-labels" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/link-labels', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/link-labels'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/link-labels",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Label a person's link to a company
Puts a label on a person's link to a company; a label already on it stays. Needs prodantix.users.write.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"distinctId": "string",
"groupType": "string",
"groupKey": "string",
"labelId": "string"
}Responses
Label a person's link to a company
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/link-labels" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"distinctId":"string","groupType":"string","groupKey":"string","labelId":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/link-labels', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"distinctId": "string",
"groupType": "string",
"groupKey": "string",
"labelId": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/link-labels'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"distinctId":"string","groupType":"string","groupKey":"string","labelId":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/link-labels",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"distinctId":"string","groupType":"string","groupKey":"string","labelId":"string"},
)Take a label off a link
Takes a label off a person's link to a company.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"distinctId": "string",
"groupType": "string",
"groupKey": "string",
"labelId": "string"
}Responses
Take a label off a link
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/link-labels/remove" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"distinctId":"string","groupType":"string","groupKey":"string","labelId":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/link-labels/remove', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"distinctId": "string",
"groupType": "string",
"groupKey": "string",
"labelId": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/link-labels/remove'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"distinctId":"string","groupType":"string","groupKey":"string","labelId":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/link-labels/remove",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"distinctId":"string","groupType":"string","groupKey":"string","labelId":"string"},
)List saved views
The caller's own views and the project's, in order, each saying whether the caller may change it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
Responses
List saved views
{
"views": [
{
"id": "string",
"name": "string",
"ownerSub": "string",
"visibility": "string",
"statuses": [],
"owners": [],
"sortBy?": "string | null",
"sortDescending": "boolean",
"layout": "string",
"boardProperty?": "string | null",
"calendarProperty?": "string | null",
"position": "integer",
"canChange": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/views" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/views', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/views'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/views",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Save a view
Saves filters, sort, columns and a table, board or calendar layout, private to the caller or shared with the project.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"name": "string",
"visibility": "string",
"filters?": "unknown",
"sort?": "unknown",
"columns?": [],
"layout?": "string | null",
"boardProperty?": "string | null",
"calendarProperty?": "string | null"
}Responses
Save a view
{
"id": "string",
"object": "string",
"groupType": "string",
"name": "string",
"ownerSub": "string",
"visibility": "string",
"filters": "unknown",
"sort": "unknown",
"columns": [],
"layout": "string",
"boardProperty?": "string | null",
"calendarProperty?": "string | null",
"position": "integer",
"canChange": "boolean",
"createdAt": "string",
"updatedAt": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/views" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","name":"string","visibility":"string","filters":"string","sort":"string","columns":[],"layout":"string","boardProperty":"string","calendarProperty":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/views', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"name": "string",
"visibility": "string",
"filters": "string",
"sort": "string",
"columns": [],
"layout": "string",
"boardProperty": "string",
"calendarProperty": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/views'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","name":"string","visibility":"string","filters":"string","sort":"string","columns":[],"layout":"string","boardProperty":"string","calendarProperty":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/views",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","name":"string","visibility":"string","filters":"string","sort":"string","columns":[],"layout":"string","boardProperty":"string","calendarProperty":"string"},
)Read a saved view
One view the caller can see.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| viewId required | path | string | The saved view |
Responses
Read a saved view
{
"id": "string",
"object": "string",
"groupType": "string",
"name": "string",
"ownerSub": "string",
"visibility": "string",
"filters": "unknown",
"sort": "unknown",
"columns": [],
"layout": "string",
"boardProperty?": "string | null",
"calendarProperty?": "string | null",
"position": "integer",
"canChange": "boolean",
"createdAt": "string",
"updatedAt": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Change a saved view
Rewrites a view. Open to its owner, and on a project view to holders of prodantix.views.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| viewId required | path | string | The saved view |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"name": "string",
"visibility": "string",
"filters?": "unknown",
"sort?": "unknown",
"columns?": [],
"layout?": "string | null",
"boardProperty?": "string | null",
"calendarProperty?": "string | null"
}Responses
Change a saved view
{
"id": "string",
"object": "string",
"groupType": "string",
"name": "string",
"ownerSub": "string",
"visibility": "string",
"filters": "unknown",
"sort": "unknown",
"columns": [],
"layout": "string",
"boardProperty?": "string | null",
"calendarProperty?": "string | null",
"position": "integer",
"canChange": "boolean",
"createdAt": "string",
"updatedAt": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","name":"string","visibility":"string","filters":"string","sort":"string","columns":[],"layout":"string","boardProperty":"string","calendarProperty":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"name": "string",
"visibility": "string",
"filters": "string",
"sort": "string",
"columns": [],
"layout": "string",
"boardProperty": "string",
"calendarProperty": "string"
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","name":"string","visibility":"string","filters":"string","sort":"string","columns":[],"layout":"string","boardProperty":"string","calendarProperty":"string"}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","name":"string","visibility":"string","filters":"string","sort":"string","columns":[],"layout":"string","boardProperty":"string","calendarProperty":"string"},
)Delete a saved view
Deletes a view, under the same rule as changing it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| viewId required | path | string | The saved view |
Responses
Delete a saved view
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Order saved views
Orders the views as ids lists them; a view the caller may not change keeps its place.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"object": "string",
"groupType?": "string",
"ids": []
}Responses
Order saved views
{
"views": [
{
"id": "string",
"name": "string",
"ownerSub": "string",
"visibility": "string",
"statuses": [],
"owners": [],
"sortBy?": "string | null",
"sortDescending": "boolean",
"layout": "string",
"boardProperty?": "string | null",
"calendarProperty?": "string | null",
"position": "integer",
"canChange": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/view-order" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","ids":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/view-order', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"ids": []
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/view-order'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","ids":[]}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/view-order",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","ids":[]},
)Read a record's timeline
Everything that happened to a person or a company, newest first, a page at a time: events under every alias, sessions, messages, conversations, property changes, tasks, notes, activities, tags and company joins.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
| subject required | query | string | The person's distinct id, or the company's key |
| kinds | query | string | Comma-separated: event, session, message, conversation, property_change, task, note, activity, tag, membership |
| before | query | string | The nextCursor of the page before |
| limit | query | string | At most this many entries, 1 to 100 (50 when absent) |
| members | query | string | On a company, false to leave its members' events out |
Responses
Read a record's timeline
{
"entries": [
{
"at": "string",
"kind": "string",
"id": "string",
"detail": "unknown"
}
],
"nextCursor?": "string | null"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/timeline" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/timeline', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/timeline'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/timeline",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List tasks
The project's tasks by status, owner and due time, the soonest due first, at most 500.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| status | query | string | open or done |
| ownerSub | query | string | The owner |
| dueBefore | query | string | Due before this RFC 3339 time |
Responses
List tasks
{
"tasks": [
{
"id": "string",
"title": "string",
"body": "string",
"type": "string",
"status": "string",
"priority": "string",
"dueAt?": "string | null",
"reminderAt?": "string | null",
"ownerSub?": "string | null",
"repeat?": "unknown",
"occurrence": "integer",
"completedAt?": "string | null",
"completedBy?": "string | null",
"createdBy": "string",
"createdAt": "string",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string"
}
]
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/tasks" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/tasks', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/tasks'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/tasks",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add a task
A to-do, call, email or meeting a member owes people or companies, with a priority, owner, due time, reminder and a repeat rule. Needs prodantix.users.write.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"title": "string",
"body?": "string",
"type?": "string",
"priority?": "string",
"dueAt?": "string | null",
"reminderAt?": "string | null",
"ownerSub?": "string | null",
"repeat?": "unknown",
"records?": [
{
"object": "string",
"groupType?": "string",
"subject": "string"
}
]
}Responses
Add a task
{
"id": "string",
"title": "string",
"body": "string",
"type": "string",
"status": "string",
"priority": "string",
"dueAt?": "string | null",
"reminderAt?": "string | null",
"ownerSub?": "string | null",
"repeat?": "unknown",
"occurrence": "integer",
"completedAt?": "string | null",
"completedBy?": "string | null",
"createdBy": "string",
"createdAt": "string",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/tasks" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"title":"string","body":"string","type":"string","priority":"string","dueAt":"string","reminderAt":"string","ownerSub":"string","repeat":"string","records":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/tasks', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"title": "string",
"body": "string",
"type": "string",
"priority": "string",
"dueAt": "string",
"reminderAt": "string",
"ownerSub": "string",
"repeat": "string",
"records": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/tasks'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"title":"string","body":"string","type":"string","priority":"string","dueAt":"string","reminderAt":"string","ownerSub":"string","repeat":"string","records":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/tasks",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"title":"string","body":"string","type":"string","priority":"string","dueAt":"string","reminderAt":"string","ownerSub":"string","repeat":"string","records":[]},
)Change a task
Rewrites a task; a changed reminder is sent again.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| taskId required | path | string | The task |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"title": "string",
"body?": "string",
"type?": "string",
"priority?": "string",
"dueAt?": "string | null",
"reminderAt?": "string | null",
"ownerSub?": "string | null",
"repeat?": "unknown",
"records?": [
{
"object": "string",
"groupType?": "string",
"subject": "string"
}
]
}Responses
Change a task
{
"id": "string",
"title": "string",
"body": "string",
"type": "string",
"status": "string",
"priority": "string",
"dueAt?": "string | null",
"reminderAt?": "string | null",
"ownerSub?": "string | null",
"repeat?": "unknown",
"occurrence": "integer",
"completedAt?": "string | null",
"completedBy?": "string | null",
"createdBy": "string",
"createdAt": "string",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"title":"string","body":"string","type":"string","priority":"string","dueAt":"string","reminderAt":"string","ownerSub":"string","repeat":"string","records":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"title": "string",
"body": "string",
"type": "string",
"priority": "string",
"dueAt": "string",
"reminderAt": "string",
"ownerSub": "string",
"repeat": "string",
"records": []
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"title":"string","body":"string","type":"string","priority":"string","dueAt":"string","reminderAt":"string","ownerSub":"string","repeat":"string","records":[]}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"title":"string","body":"string","type":"string","priority":"string","dueAt":"string","reminderAt":"string","ownerSub":"string","repeat":"string","records":[]},
)Delete a task
Removes a task from every record it is on.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| taskId required | path | string | The task |
Responses
Delete a task
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Complete or reopen a task
Marks a task done, or open again with done false. Done on a repeating task opens the next one, answered as next.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| taskId required | path | string | The task |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"done?": "boolean"
}Responses
Complete or reopen a task
{
"task": {
"id": "string",
"title": "string",
"body": "string",
"type": "string",
"status": "string",
"priority": "string",
"dueAt?": "string | null",
"reminderAt?": "string | null",
"ownerSub?": "string | null",
"repeat?": "unknown",
"occurrence": "integer",
"completedAt?": "string | null",
"completedBy?": "string | null",
"createdBy": "string",
"createdAt": "string",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string"
}
]
},
"next?": {
"id": "string",
"title": "string",
"body": "string",
"type": "string",
"status": "string",
"priority": "string",
"dueAt?": "string | null",
"reminderAt?": "string | null",
"ownerSub?": "string | null",
"repeat?": "unknown",
"occurrence": "integer",
"completedAt?": "string | null",
"completedBy?": "string | null",
"createdBy": "string",
"createdAt": "string",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string"
}
]
}
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId/complete" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"done":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId/complete', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"done": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId/complete'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"done":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId/complete",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"done":true},
)Write a note
A note on people and companies, in the console's rich text. Needs prodantix.users.write.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"body": "unknown",
"pinned?": "boolean",
"records?": [
{
"object": "string",
"groupType?": "string",
"subject": "string"
}
]
}Responses
Write a note
{
"id": "string",
"body": "unknown",
"pinned": "boolean",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/notes" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"body":"string","pinned":true,"records":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/notes', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"body": "string",
"pinned": true,
"records": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/notes'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"body":"string","pinned":true,"records":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/notes",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"body":"string","pinned":true,"records":[]},
)Change a note
Rewrites a note's text or pin. Open to its author and to holders of prodantix.users.write.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| noteId required | path | string | The note |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"body": "unknown",
"pinned?": "boolean",
"records?": [
{
"object": "string",
"groupType?": "string",
"subject": "string"
}
]
}Responses
Change a note
{
"id": "string",
"body": "unknown",
"pinned": "boolean",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/crm/notes/:noteId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"body":"string","pinned":true,"records":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/notes/:noteId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"body": "string",
"pinned": true,
"records": []
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/notes/:noteId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"body":"string","pinned":true,"records":[]}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/crm/notes/:noteId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"body":"string","pinned":true,"records":[]},
)Delete a note
Removes a note, under the same rule as changing it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| noteId required | path | string | The note |
Responses
Delete a note
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/notes/:noteId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/notes/:noteId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/notes/:noteId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/notes/:noteId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Log an activity
Logs a call, meeting or email against people and companies, with its outcome, direction and duration.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"kind": "string",
"occurredAt": "string",
"durationS?": "integer | null",
"outcome?": "string | null",
"direction?": "string | null",
"subject?": "string",
"body?": "string",
"attendees?": "unknown",
"records": [
{
"object": "string",
"groupType?": "string",
"subject": "string"
}
]
}Responses
Log an activity
{
"id": "string",
"kind": "string",
"occurredAt": "string",
"durationS?": "integer | null",
"outcome?": "string | null",
"direction?": "string | null",
"subject": "string",
"body": "string",
"attendees": "unknown",
"createdBy": "string",
"createdAt": "string",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/activities" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"kind":"string","occurredAt":"string","durationS":0,"outcome":"string","direction":"string","subject":"string","body":"string","attendees":"string","records":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/activities', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"kind": "string",
"occurredAt": "string",
"durationS": 0,
"outcome": "string",
"direction": "string",
"subject": "string",
"body": "string",
"attendees": "string",
"records": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/activities'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"kind":"string","occurredAt":"string","durationS":0,"outcome":"string","direction":"string","subject":"string","body":"string","attendees":"string","records":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/activities",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"kind":"string","occurredAt":"string","durationS":0,"outcome":"string","direction":"string","subject":"string","body":"string","attendees":"string","records":[]},
)Delete an activity
Removes a logged activity.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| activityId required | path | string | The activity |
Responses
Delete an activity
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/activities/:activityId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/activities/:activityId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/activities/:activityId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/activities/:activityId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List tags
The project's tags, by name.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
List tags
{
"tags": [
{
"id": "string",
"name": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/tags" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/tags', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/tags'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/tags",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add a tag
A tag people and companies can carry; the console colours it from its id. Needs prodantix.properties.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string"
}Responses
Add a tag
{
"id": "string",
"name": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/tags" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/tags', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/tags'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/tags",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string"},
)Change a tag
Renames a tag everywhere it is on.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| tagId required | path | string | The tag |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string"
}Responses
Change a tag
{
"id": "string",
"name": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/crm/tags/:tagId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/tags/:tagId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string"
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/tags/:tagId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string"}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/crm/tags/:tagId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string"},
)Delete a tag
Deletes a tag and takes it off every record.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| tagId required | path | string | The tag |
Responses
Delete a tag
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/tags/:tagId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/tags/:tagId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/tags/:tagId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/tags/:tagId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a record's tags
The tags on one person or company.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
| subject required | query | string | The person's distinct id, or the company's key |
Responses
Read a record's tags
{
"tags": [
{
"id": "string",
"name": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/record-tags" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/record-tags', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/record-tags'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/record-tags",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Tag a record
Puts a tag on a person or company. Needs prodantix.users.write.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"tagId": "string",
"record": {
"object": "string",
"groupType?": "string",
"subject": "string"
}
}Responses
Tag a record
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/record-tags" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"tagId":"string","record":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/record-tags', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"tagId": "string",
"record": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/record-tags'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"tagId":"string","record":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/record-tags",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"tagId":"string","record":"string"},
)Untag a record
Takes a tag off a person or company.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"tagId": "string",
"record": {
"object": "string",
"groupType?": "string",
"subject": "string"
}
}Responses
Untag a record
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/record-tags/remove" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"tagId":"string","record":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/record-tags/remove', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"tagId": "string",
"record": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/record-tags/remove'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"tagId":"string","record":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/record-tags/remove",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"tagId":"string","record":"string"},
)List lifecycle rules
One object's stage rules, at most one per stage, each with the cohort definition that moves a record into it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
Responses
List lifecycle rules
{
"rules": [
{
"id": "string",
"stage": "string",
"definition": "unknown",
"enabled": "boolean"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add a lifecycle rule
The conditions that move a record forward into a stage. Rules never move a stage back. Needs prodantix.properties.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"stage": "string",
"definition": "unknown",
"enabled?": "boolean"
}Responses
Add a lifecycle rule
{
"id": "string",
"stage": "string",
"definition": "unknown",
"enabled": "boolean"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","stage":"string","definition":"string","enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"stage": "string",
"definition": "string",
"enabled": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","stage":"string","definition":"string","enabled":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","stage":"string","definition":"string","enabled":true},
)Change a lifecycle rule
Rewrites a stage rule's conditions, or switches it on or off.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| ruleId required | path | string | The rule |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"stage": "string",
"definition": "unknown",
"enabled?": "boolean"
}Responses
Change a lifecycle rule
{
"id": "string",
"stage": "string",
"definition": "unknown",
"enabled": "boolean"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules/:ruleId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","stage":"string","definition":"string","enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules/:ruleId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"stage": "string",
"definition": "string",
"enabled": true
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules/:ruleId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","stage":"string","definition":"string","enabled":true}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules/:ruleId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","stage":"string","definition":"string","enabled":true},
)Delete a lifecycle rule
Records stay where they are; no rule moves them into that stage again.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| ruleId required | path | string | The rule |
Responses
Delete a lifecycle rule
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules/:ruleId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules/:ruleId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules/:ruleId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules/:ruleId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Count records by stage
How many of one object's records hold each stage now, in stage order.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
Responses
Count records by stage
{
"stages": [
{
"stage": "string",
"count": "integer"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/stages" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/stages', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/stages'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/stages",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the Lifecycle stages report
Over a range of at most a year and a day: records in each stage now, records entering each stage per week, and from one stage to the next how many moved on, the conversion and the median days.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
| from required | query | string | The range's start, RFC 3339 |
| to required | query | string | The range's end, RFC 3339 |
Responses
Read the Lifecycle stages report
{
"stages": [
{
"stage": "string",
"count": "integer"
}
],
"entered": [
{
"week": "string",
"stage": "string",
"count": "integer"
}
],
"steps": [
{
"from": "string",
"to": "string",
"entered": "integer",
"movedOn": "integer",
"conversion?": "number | null",
"medianDays?": "number | null"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/report" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/report', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/report'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/report",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the lifecycle setting
Whether the project lets a stage move backwards.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
Read the lifecycle setting
{
"backwards": "boolean"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/settings" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/settings', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/settings'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/settings",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Change the lifecycle setting
Lets a stage move backwards, or holds every record to moving forward. Needs prodantix.properties.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"backwards": "boolean"
}Responses
Change the lifecycle setting
{
"backwards": "boolean"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/settings" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"backwards":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/settings', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"backwards": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/settings'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"backwards":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/settings",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"backwards":true},
)List routing rules
One object's routing rules in the order they are tried, each with its owners and who is next.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
Responses
List routing rules
{
"rules": [
{
"id": "string",
"name": "string",
"onStage?": "string | null",
"definition": "unknown",
"owners": [],
"nextOwner?": "string | null",
"position": "integer",
"enabled": "boolean"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add a routing rule
Hands records arriving without an owner, or entering a stage, to members in turn. Needs prodantix.properties.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"name": "string",
"onStage?": "string | null",
"definition": "unknown",
"owners": [],
"enabled?": "boolean"
}Responses
Add a routing rule
{
"id": "string",
"name": "string",
"onStage?": "string | null",
"definition": "unknown",
"owners": [],
"nextOwner?": "string | null",
"position": "integer",
"enabled": "boolean"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","name":"string","onStage":"string","definition":"string","owners":[],"enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"name": "string",
"onStage": "string",
"definition": "string",
"owners": [],
"enabled": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","name":"string","onStage":"string","definition":"string","owners":[],"enabled":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","name":"string","onStage":"string","definition":"string","owners":[],"enabled":true},
)Change a routing rule
Rewrites a routing rule; new owners start the turn over.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| ruleId required | path | string | The rule |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"name": "string",
"onStage?": "string | null",
"definition": "unknown",
"owners": [],
"enabled?": "boolean"
}Responses
Change a routing rule
{
"id": "string",
"name": "string",
"onStage?": "string | null",
"definition": "unknown",
"owners": [],
"nextOwner?": "string | null",
"position": "integer",
"enabled": "boolean"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules/:ruleId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","name":"string","onStage":"string","definition":"string","owners":[],"enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules/:ruleId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"name": "string",
"onStage": "string",
"definition": "string",
"owners": [],
"enabled": true
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules/:ruleId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","name":"string","onStage":"string","definition":"string","owners":[],"enabled":true}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules/:ruleId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","name":"string","onStage":"string","definition":"string","owners":[],"enabled":true},
)Delete a routing rule
Records keep the owners it gave them.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| ruleId required | path | string | The rule |
Responses
Delete a routing rule
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules/:ruleId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules/:ruleId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules/:ruleId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules/:ruleId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Reorder routing rules
The order routing rules are tried in, every rule named once.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"ruleIds": []
}Responses
Reorder routing rules
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/routing/order" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"ruleIds":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/routing/order', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"ruleIds": []
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/routing/order'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"ruleIds":[]}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/routing/order",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"ruleIds":[]},
)Upload an import file
The CSV as the request body, at most 100 MB: kept for the import it becomes, and answered with each column's first values and the property it proposes to write. Needs prodantix.users.write.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
Upload an import file
{
"fileId": "string",
"size": "integer",
"columns": [
{
"name": "string",
"samples": [],
"proposal": "unknown"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/imports/files" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/imports/files', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/imports/files'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/imports/files",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List imports
The project's imports, the newest first, while they are kept (90 days).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
List imports
{
"imports": [
{
"id": "string",
"status": "string",
"fileName": "string",
"object": "string",
"groupType": "string",
"mode": "string",
"overwrite": "string",
"counts": {
"read": "integer",
"created": "integer",
"updated": "integer",
"skipped": "integer",
"refused": "integer"
},
"failure?": "string | null",
"createdBy": "string",
"createdAt": "string",
"finishedAt?": "string | null",
"expiresAt": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/imports" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/imports', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/imports'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/imports",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Start an import
Queues an uploaded file's import with its mapping, its mode (create and update, create only, update only) and whether it overwrites or only fills empty properties. Defining new properties needs prodantix.properties.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"fileId": "string",
"fileName?": "string",
"object": "string",
"groupType?": "string",
"mode": "string",
"overwrite": "string",
"header": [],
"columns": "unknown",
"newProperties?": "unknown"
}Responses
Start an import
{
"id": "string",
"status": "string",
"fileName": "string",
"object": "string",
"groupType": "string",
"mode": "string",
"overwrite": "string",
"counts": {
"read": "integer",
"created": "integer",
"updated": "integer",
"skipped": "integer",
"refused": "integer"
},
"failure?": "string | null",
"createdBy": "string",
"createdAt": "string",
"finishedAt?": "string | null",
"expiresAt": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/imports" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"fileId":"string","fileName":"string","object":"string","groupType":"string","mode":"string","overwrite":"string","header":[],"columns":"string","newProperties":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/imports', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"fileId": "string",
"fileName": "string",
"object": "string",
"groupType": "string",
"mode": "string",
"overwrite": "string",
"header": [],
"columns": "string",
"newProperties": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/imports'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"fileId":"string","fileName":"string","object":"string","groupType":"string","mode":"string","overwrite":"string","header":[],"columns":"string","newProperties":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/imports",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"fileId":"string","fileName":"string","object":"string","groupType":"string","mode":"string","overwrite":"string","header":[],"columns":"string","newProperties":"string"},
)Read an import
An import's status and its counts of rows read, created, updated, skipped and refused.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| importId required | path | string | The import |
Responses
Read an import
{
"id": "string",
"status": "string",
"fileName": "string",
"object": "string",
"groupType": "string",
"mode": "string",
"overwrite": "string",
"counts": {
"read": "integer",
"created": "integer",
"updated": "integer",
"skipped": "integer",
"refused": "integer"
},
"failure?": "string | null",
"createdBy": "string",
"createdAt": "string",
"finishedAt?": "string | null",
"expiresAt": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Cancel an import
Stops a waiting or running import; the rows it already wrote stay.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| importId required | path | string | The import |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
Cancel an import
{
"id": "string",
"status": "string",
"fileName": "string",
"object": "string",
"groupType": "string",
"mode": "string",
"overwrite": "string",
"counts": {
"read": "integer",
"created": "integer",
"updated": "integer",
"skipped": "integer",
"refused": "integer"
},
"failure?": "string | null",
"createdBy": "string",
"createdAt": "string",
"finishedAt?": "string | null",
"expiresAt": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId/cancel" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId/cancel', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId/cancel'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId/cancel",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Download skipped and refused rows
Every row the import skipped or refused, as the file had it, with the outcome and the reason.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| importId required | path | string | The import |
Responses
Download skipped and refused rows
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId/rows.csv" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId/rows.csv', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId/rows.csv'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId/rows.csv",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List exports
The project's queued exports, the newest first, while their files are kept.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
List exports
{
"exports": [
{
"id": "string",
"status": "string",
"object": "string",
"format": "string",
"rows": "integer",
"ready": "boolean",
"failure?": "string | null",
"createdBy": "string",
"createdAt": "string",
"finishedAt?": "string | null",
"expiresAt": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/exports" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/exports', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/exports'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/exports",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Export people or companies
The rows a saved view or a search selects, in the columns asked for, as CSV or JSON: the file itself when there are at most 10,000, otherwise 202 with an export that writes the file, kept 7 days.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"viewId?": "string | null",
"search?": "string | null",
"columns": [],
"format?": "string"
}Responses
Export people or companies
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/exports" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","viewId":"string","search":"string","columns":[],"format":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/exports', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"viewId": "string",
"search": "string",
"columns": [],
"format": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/exports'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","viewId":"string","search":"string","columns":[],"format":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/exports",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","viewId":"string","search":"string","columns":[],"format":"string"},
)Count an export's rows
How many rows an export of a saved view or a search would write, before any column is chosen: people by view and search, companies of one type by search.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for companies |
| viewId | query | string | A saved view whose rows to count |
| search | query | string | A search term |
Responses
Count an export's rows
{
"rows": "integer"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/exports/count" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/exports/count', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/exports/count'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/exports/count",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read an export
A queued export's status, the rows it has written and whether its file is ready.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| exportId required | path | string | The export |
Responses
Read an export
{
"id": "string",
"status": "string",
"object": "string",
"format": "string",
"rows": "integer",
"ready": "boolean",
"failure?": "string | null",
"createdBy": "string",
"createdAt": "string",
"finishedAt?": "string | null",
"expiresAt": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Cancel an export
Stops a queued export; it leaves no file.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| exportId required | path | string | The export |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
Cancel an export
{
"id": "string",
"status": "string",
"object": "string",
"format": "string",
"rows": "integer",
"ready": "boolean",
"failure?": "string | null",
"createdBy": "string",
"createdAt": "string",
"finishedAt?": "string | null",
"expiresAt": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId/cancel" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId/cancel', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId/cancel'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId/cancel",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Download an export
A finished export's file.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| exportId required | path | string | The export |
Responses
Download an export
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId/file" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId/file', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId/file'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId/file",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List scores
The project's lead scores with their groups, tiers and the two properties each writes. Needs lead scoring in the plan.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object | query | string | Only scores of person or company |
| groupType | query | string | The company type, for object company |
Responses
List scores
{
"scores": [
{
"id": "string",
"object": "string",
"groupType": "string",
"name": "string",
"kind": "string",
"groups": "unknown",
"cap?": "integer | null",
"decay?": {
"percent": "integer",
"months": "integer"
},
"thresholds": [
{
"label": "string",
"min": "integer"
}
],
"scoreProperty": "string",
"tierProperty": "string",
"conversionStage": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/scores" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/scores', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/scores'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/scores",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a score
Creates a score with its value and tier properties and scores every record of its object once. Needs prodantix.properties.manage and lead scoring in the plan.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"name": "string",
"kind": "string",
"groups?": "unknown",
"cap?": "integer | null",
"decay?": {
"percent": "integer",
"months": "integer"
},
"thresholds?": [
{
"label": "string",
"min": "integer"
}
],
"conversionStage?": "string"
}Responses
Create a score
{
"id": "string",
"object": "string",
"groupType": "string",
"name": "string",
"kind": "string",
"groups": "unknown",
"cap?": "integer | null",
"decay?": {
"percent": "integer",
"months": "integer"
},
"thresholds": [
{
"label": "string",
"min": "integer"
}
],
"scoreProperty": "string",
"tierProperty": "string",
"conversionStage": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/scores" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","name":"string","kind":"string","groups":"string","cap":0,"decay":"string","thresholds":[],"conversionStage":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/scores', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"name": "string",
"kind": "string",
"groups": "string",
"cap": 0,
"decay": "string",
"thresholds": [],
"conversionStage": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/scores'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","name":"string","kind":"string","groups":"string","cap":0,"decay":"string","thresholds":[],"conversionStage":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/scores",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","name":"string","kind":"string","groups":"string","cap":0,"decay":"string","thresholds":[],"conversionStage":"string"},
)Update a score
Rewrites a score's groups, tiers and decay and scores every record once more. Needs prodantix.properties.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| scoreId required | path | string | The score |
Body
{
"object": "string",
"groupType?": "string",
"name": "string",
"kind": "string",
"groups?": "unknown",
"cap?": "integer | null",
"decay?": {
"percent": "integer",
"months": "integer"
},
"thresholds?": [
{
"label": "string",
"min": "integer"
}
],
"conversionStage?": "string"
}Responses
Update a score
{
"id": "string",
"object": "string",
"groupType": "string",
"name": "string",
"kind": "string",
"groups": "unknown",
"cap?": "integer | null",
"decay?": {
"percent": "integer",
"months": "integer"
},
"thresholds": [
{
"label": "string",
"min": "integer"
}
],
"scoreProperty": "string",
"tierProperty": "string",
"conversionStage": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","name":"string","kind":"string","groups":"string","cap":0,"decay":"string","thresholds":[],"conversionStage":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"name": "string",
"kind": "string",
"groups": "string",
"cap": 0,
"decay": "string",
"thresholds": [],
"conversionStage": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","name":"string","kind":"string","groups":"string","cap":0,"decay":"string","thresholds":[],"conversionStage":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","name":"string","kind":"string","groups":"string","cap":0,"decay":"string","thresholds":[],"conversionStage":"string"},
)Delete a score
Removes a score; its two properties are archived with their values. Needs prodantix.properties.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| scoreId required | path | string | The score |
Responses
Delete a score
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Rescore every record
Queues a pass that scores every record of the score's object now, answering the job's id. Needs prodantix.properties.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| scoreId required | path | string | The score |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
Rescore every record
{
"jobId": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId/rescore" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId/rescore', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId/rescore'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId/rescore",
headers={"Authorization": f"Bearer {bearer_auth}"},
)A score's distribution
How a score's records spread across its tiers: the records in each tier from the lowest, those scored under every tier and those not scored. Needs lead scoring in the plan.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| scoreId required | path | string | The score |
Responses
A score's distribution
{
"tiers": [
{
"label": "string",
"min?": "integer | null",
"records": "integer"
}
],
"below": "integer",
"unscored": "integer"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId/distribution" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId/distribution', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId/distribution'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId/distribution",
headers={"Authorization": f"Bearer {bearer_auth}"},
)A record's score history
Each change of a record's scores, newest first, with its fit and engagement parts and what caused it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| subject required | query | string | The record: a person's id, or a company's key |
| scoreId | query | string | Only this score's changes |
| since | query | string | Changes from this RFC 3339 time; 30 days back by default |
Responses
A record's score history
{
"changes": [
{
"scoreId": "string",
"value": "integer",
"tier?": "string | null",
"fit": "integer",
"engagement": "integer",
"cause": "string",
"at": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/score-history" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/score-history', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/score-history'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/score-history",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List duplicates
One object's open duplicate pairs, the exact matches first, with both records' properties.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
Responses
List duplicates
{
"duplicates": [
{
"id": "string",
"object": "string",
"groupType": "string",
"signals": [],
"first": {
"subject": "string",
"properties": "unknown",
"firstSeenAt?": "string | null",
"eventCount": "integer"
},
"second": {
"subject": "string",
"properties": "unknown",
"firstSeenAt?": "string | null",
"eventCount": "integer"
}
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/duplicates" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/duplicates', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/duplicates'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/duplicates",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Dismiss duplicates
Marks pairs not duplicates; a pair comes back only on a signal it did not have.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"duplicateIds": []
}Responses
Dismiss duplicates
{
"dismissed": "integer"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/dismiss" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"duplicateIds":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/dismiss', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"duplicateIds": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/dismiss'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"duplicateIds":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/dismiss",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"duplicateIds":[]},
)Merge a duplicate pair
Keeps the record keep names; the other's values fill only what it has empty, and its links move across.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| duplicateId required | path | string | The pair |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"keep": "string"
}Responses
Merge a duplicate pair
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/:duplicateId/merge" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"keep":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/:duplicateId/merge', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"keep": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/:duplicateId/merge'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"keep":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/:duplicateId/merge",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"keep":"string"},
)Look for duplicates now
Searches the project's people and companies now rather than at the next daily pass.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
Look for duplicates now
{
"jobId": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/refresh" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/refresh', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/refresh'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/refresh",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the duplicates setting
Whether exact email and domain matches merge on their own.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
Read the duplicates setting
{
"autoMerge": "boolean"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/settings" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/settings', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/settings'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/settings",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Change the duplicates setting
Switches the automatic merging of exact email and domain matches; looser matches always wait for a member. Needs prodantix.properties.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"autoMerge": "boolean"
}Responses
Change the duplicates setting
{
"autoMerge": "boolean"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/settings" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"autoMerge":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/settings', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"autoMerge": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/settings'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"autoMerge":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/settings",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"autoMerge":true},
)List formatting rules
Every property of one object that carries formatting rules, built-in properties with their defaults.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
Responses
List formatting rules
{
"properties": [
{
"property": "string",
"rules": [
{
"rule": "string",
"mode": "string",
"country?": "string | null"
}
]
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/format-rules" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/format-rules', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/format-rules'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/format-rules",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Set a property's formatting rules
Replaces the property's rules, in the order they apply; a rule added or switched queues a scan of the existing records. Needs prodantix.properties.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| property required | path | string | The property's name |
Body
{
"object": "string",
"groupType?": "string",
"rules": [
{
"rule": "string",
"mode": "string",
"country?": "string | null"
}
]
}Responses
Set a property's formatting rules
{
"rules": [
{
"rule": "string",
"mode": "string",
"country?": "string | null"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/format-rules/:property" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","rules":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/format-rules/:property', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"rules": []
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/format-rules/:property'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","rules":[]}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/format-rules/:property",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","rules":[]},
)List formatting issues
One object's values a formatting rule would change, by property then record, after a cursor.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
| property | query | string | Only this property's issues |
| rule | query | string | Only the issues raised under this rule |
| afterProperty | query | string | The cursor's property |
| afterSubject | query | string | The cursor's record |
| limit | query | string | At most this many, up to 200 |
Responses
List formatting issues
{
"issues": [
{
"subject": "string",
"property": "string",
"rules": [],
"current": "string",
"suggested": "string"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/format-issues" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/format-issues', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/format-issues'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/format-issues",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Count formatting issues
How many issues each property holds under each rule.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
Responses
Count formatting issues
{
"counts": [
{
"property": "string",
"rule": "string",
"count": "integer"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/format-issues/counts" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/format-issues/counts', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/format-issues/counts'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/format-issues/counts",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Apply formatting fixes
Writes the suggested values of the records named, or of every issue of the property, as console edits.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| property required | path | string | The property's name |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"rule?": "string | null",
"subjects?": []
}Responses
Apply formatting fixes
{
"applied": "integer"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/format-issues/:property/apply" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","rule":"string","subjects":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/format-issues/:property/apply', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"rule": "string",
"subjects": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/format-issues/:property/apply'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","rule":"string","subjects":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/format-issues/:property/apply",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","rule":"string","subjects":[]},
)Count the data quality lists
How many entries each list of the data quality overview holds: refused values, undefined properties, formatting issues, open duplicates and property health.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
| importId | query | string | An import's id, to count only the values that import's rows had refused |
Responses
Count the data quality lists
{
"refused": "integer",
"undefined": "integer",
"formatting": "integer",
"duplicates": "integer",
"health": "integer"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/data-quality/counts" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/data-quality/counts', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/data-quality/counts'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/data-quality/counts",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read property health
Per property, the records holding a value, the share of all records, and those written in the last 30 days, with the defined properties no record holds.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| object required | query | string | person or company |
| groupType | query | string | The company type, for object company |
Responses
Read property health
{
"properties": [
{
"property": "string",
"held": "integer",
"recent": "integer",
"share": "number",
"isDefined": "boolean"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/data-quality/health" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/data-quality/health', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/data-quality/health'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/data-quality/health",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List forms
The project's forms by name, archived ones left out.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the forms belong to |
Responses
200 The forms
{
"forms": [
{
"id": "string",
"name": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/forms" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/forms', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/forms'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/forms",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a form
A draft form from its steps, settings and style; nothing serves until it is published. Counted against the plan's max_forms; a file field needs form_file_uploads. Needs prodantix.forms.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the forms belong to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"definition": "unknown"
}Responses
The draft
{
"id": "string",
"name": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}The form does not read, or a field, condition or colour is refused
The plan holds no more forms, or has no file uploads
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/forms" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","definition":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/forms', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"definition": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/forms'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","definition":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/forms",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","definition":"string"},
)Read a form
The form with its draft and its published version.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the forms belong to |
| formId required | path | string | The form |
Responses
The form
{
"id": "string",
"name": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}No such form
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/forms/:formId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/forms/:formId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/forms/:formId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/forms/:formId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Change a form's draft
Rewrites the draft and the name; a published form keeps serving its live version until the draft is published. Needs prodantix.forms.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the forms belong to |
| formId required | path | string | The form |
Body
{
"name": "string",
"definition": "unknown"
}Responses
The form
{
"id": "string",
"name": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}The form is refused
No such form
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/forms/:formId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","definition":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/forms/:formId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"definition": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/forms/:formId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","definition":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/forms/:formId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","definition":"string"},
)Publish a form
Freezes the draft as the next version and serves it. Needs prodantix.forms.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the forms belong to |
| formId required | path | string | The form |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The form
{
"id": "string",
"name": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}No such form
The form is archived
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/forms/:formId/publish" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/forms/:formId/publish', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/forms/:formId/publish'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/forms/:formId/publish",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Archive a form
It stops taking responses; its submissions stay. Needs prodantix.forms.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the forms belong to |
| formId required | path | string | The form |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The form
{
"id": "string",
"name": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}No such form
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/forms/:formId/archive" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/forms/:formId/archive', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/forms/:formId/archive'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/forms/:formId/archive",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List a form's submissions
Newest first, a page at a time.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the forms belong to |
| formId required | path | string | The form |
| limit | query | string | At most this many, up to 500 |
| before | query | string | Only submissions before this time |
Responses
200 The submissions
{
"submissions": [
{
"id": "string",
"version": "integer",
"distinctId": "string",
"answers": "unknown",
"pageUrl": "string",
"submittedAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/forms/:formId/submissions" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/forms/:formId/submissions', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/forms/:formId/submissions'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/forms/:formId/submissions",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a form's numbers
Views, starts, submissions and conversion by day.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the forms belong to |
| formId required | path | string | The form |
| days | query | string | The days counted back from today, up to 365 |
Responses
200 The days
{
"days": [
{
"day": "string",
"views": "integer",
"starts": "integer",
"submissions": "integer",
"conversion?": "number | null"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/forms/:formId/analytics" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/forms/:formId/analytics', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/forms/:formId/analytics'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/forms/:formId/analytics",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Delete a submission
Needs prodantix.forms.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the forms belong to |
| submissionId required | path | string | The submission |
Responses
Deleted
No such submission
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/form-submissions/:submissionId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/form-submissions/:submissionId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/form-submissions/:submissionId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/form-submissions/:submissionId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read every form's numbers
Each form's views, starts, submissions and conversion over the last days, for the forms list.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the forms belong to |
| days | query | string | The days counted back from today, up to 365 |
Responses
200 The forms' numbers
{
"forms": [
{
"pageId": "string",
"views": "integer",
"visitors": "integer",
"submissions": "integer"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/form-totals" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/form-totals', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/form-totals'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/form-totals",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List CTAs
The project's CTAs by name, archived ones left out.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the CTAs belong to |
Responses
200 The CTAs
{
"ctas": [
{
"id": "string",
"name": "string",
"kind": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/ctas" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ctas', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ctas'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/ctas",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a CTA
A draft CTA from its kind, variants, targeting, trigger, frequency and schedule; nothing shows until it is published. Needs crm_ctas, and cta_variants for a second variant. Needs prodantix.ctas.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the CTAs belong to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"definition": "unknown"
}Responses
The draft
{
"id": "string",
"name": "string",
"kind": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}The CTA does not read, or a variant, rule or colour is refused
The plan has no CTAs, or no variants
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/ctas" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","definition":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ctas', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"definition": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ctas'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","definition":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/ctas",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","definition":"string"},
)Read a CTA
The CTA with its draft and its published version.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the CTAs belong to |
| ctaId required | path | string | The CTA |
Responses
The CTA
{
"id": "string",
"name": "string",
"kind": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}No such CTA
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Change a CTA's draft
Rewrites the draft and the name; a live CTA keeps showing its published version until the draft is published. Needs prodantix.ctas.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the CTAs belong to |
| ctaId required | path | string | The CTA |
Body
{
"name": "string",
"definition": "unknown"
}Responses
The CTA
{
"id": "string",
"name": "string",
"kind": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}The CTA is refused
No such CTA
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","definition":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"definition": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","definition":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","definition":"string"},
)Publish a CTA
Freezes the draft as the next version and makes it live; a CTA not live yet takes one of the plan's max_live_ctas places. Needs prodantix.ctas.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the CTAs belong to |
| ctaId required | path | string | The CTA |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The CTA
{
"id": "string",
"name": "string",
"kind": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}The plan holds no more live CTAs, or has no CTAs
No such CTA
The CTA is archived or was never published
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/publish" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/publish', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/publish'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/publish",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Pause a CTA
Takes a live CTA off every page and frees its place under the plan. Needs prodantix.ctas.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the CTAs belong to |
| ctaId required | path | string | The CTA |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The CTA
{
"id": "string",
"name": "string",
"kind": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}The plan holds no more live CTAs, or has no CTAs
No such CTA
The CTA is archived or was never published
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/pause" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/pause', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/pause'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/pause",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Resume a CTA
Shows a paused CTA's published version again, in one of the plan's live places. Needs prodantix.ctas.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the CTAs belong to |
| ctaId required | path | string | The CTA |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The CTA
{
"id": "string",
"name": "string",
"kind": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}The plan holds no more live CTAs, or has no CTAs
No such CTA
The CTA is archived or was never published
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/resume" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/resume', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/resume'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/resume",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Archive a CTA
It leaves every page and the list; its events stay. Needs prodantix.ctas.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the CTAs belong to |
| ctaId required | path | string | The CTA |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The CTA
{
"id": "string",
"name": "string",
"kind": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}The plan holds no more live CTAs, or has no CTAs
No such CTA
The CTA is archived or was never published
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/archive" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/archive', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/archive'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/archive",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a CTA's report
Views, clicks, dismissals and conversions by day and variant, each variant's totals and rates, and the variant ahead on clicks and on conversions with whether its lead holds at 95%.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the CTAs belong to |
| ctaId required | path | string | The CTA |
| days | query | string | The days counted back from today, up to 365 |
Responses
The report
{
"days": [
{
"day": "string",
"variant": "string",
"views": "integer",
"clicks": "integer",
"dismissals": "integer"
}
],
"variants": [
{
"variant": "string",
"views": "integer",
"visitors": "integer",
"submissions": "integer",
"ctaClicks": "integer",
"submissionRate?": "number | null",
"bounceRate?": "number | null",
"averageSeconds?": "number | null"
}
],
"clickLead?": {
"variant": "string",
"rate": "number",
"isSignificant": "boolean"
},
"conversionLead?": {
"variant": "string",
"rate": "number",
"isSignificant": "boolean"
}
}No such CTA
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/report" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/report', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/report'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/report",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read every CTA's numbers
Each CTA's views, clicks, dismissals and click rate over the last days, for the CTA list.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the CTAs belong to |
| days | query | string | The days counted back from today, up to 365 |
Responses
200 The CTAs' numbers
{
"ctas": [
{
"pageId": "string",
"views": "integer",
"visitors": "integer",
"submissions": "integer"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/cta-totals" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cta-totals', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cta-totals'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/cta-totals",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List landing pages
The project's landing pages by name and language, archived ones left out.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the pages belong to |
Responses
200 The pages
{
"pages": [
{
"id": "string",
"name": "string",
"domain?": "string | null",
"path": "string",
"language": "string",
"translationGroup": "string",
"template": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/pages" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/pages', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/pages'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/pages",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a landing page
A draft page at an address (a content domain of the project or its page host, a path and a language) from its variants of sections, theme and SEO; nothing is served until it is published. `translationOf` makes it another language of that page. Needs crm_landing_pages, landing_page_smart_content for a section by cohort, stage or device, and landing_page_variants for a second variant. Needs prodantix.pages.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the pages belong to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"address": {
"domain?": "string | null",
"path": "string",
"language": "string"
},
"template?": "string | null",
"translationOf?": "string | null",
"definition": "unknown"
}Responses
The draft
{
"id": "string",
"name": "string",
"domain?": "string | null",
"path": "string",
"language": "string",
"translationGroup": "string",
"template": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}The page does not read, a section or colour is refused, or the address or domain is
The plan has no landing pages, smart content or variants
Another page lives at the address in this language
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/pages" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","address":"string","template":"string","translationOf":"string","definition":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/pages', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"address": "string",
"template": "string",
"translationOf": "string",
"definition": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/pages'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","address":"string","template":"string","translationOf":"string","definition":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/pages",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","address":"string","template":"string","translationOf":"string","definition":"string"},
)Read a landing page
The page with its address, draft and published version.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the pages belong to |
| pageId required | path | string | The page |
Responses
The page
{
"id": "string",
"name": "string",
"domain?": "string | null",
"path": "string",
"language": "string",
"translationGroup": "string",
"template": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}No such page
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/pages/:pageId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/pages/:pageId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/pages/:pageId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/pages/:pageId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Change a landing page's draft
Rewrites the draft, name and address; a published page keeps serving its published version until the draft is published. Needs prodantix.pages.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the pages belong to |
| pageId required | path | string | The page |
Body
{
"name": "string",
"address": {
"domain?": "string | null",
"path": "string",
"language": "string"
},
"definition": "unknown"
}Responses
The page
{
"id": "string",
"name": "string",
"domain?": "string | null",
"path": "string",
"language": "string",
"translationGroup": "string",
"template": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}The page or its address is refused
No such page
Another page lives at the address in this language
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/pages/:pageId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","address":"string","definition":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/pages/:pageId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"address": "string",
"definition": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/pages/:pageId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","address":"string","definition":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/pages/:pageId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","address":"string","definition":"string"},
)Publish a landing page
Freezes the draft as the next version and serves it; a page none of whose languages is published yet takes one of the plan's max_landing_pages places. Needs prodantix.pages.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the pages belong to |
| pageId required | path | string | The page |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The page
{
"id": "string",
"name": "string",
"domain?": "string | null",
"path": "string",
"language": "string",
"translationGroup": "string",
"template": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}The draft is refused
The plan holds no more published pages, or lacks a feature the draft uses
No such page
The page is archived
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/publish" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/publish', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/publish'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/publish",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Take a landing page offline
The page answers 404 until it is published again, and keeps its address and versions. Needs prodantix.pages.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the pages belong to |
| pageId required | path | string | The page |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The page
{
"id": "string",
"name": "string",
"domain?": "string | null",
"path": "string",
"language": "string",
"translationGroup": "string",
"template": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}No such page
The page is not published
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/unpublish" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/unpublish', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/unpublish'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/unpublish",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Archive a landing page
It stops serving, frees its address and leaves the list; its events stay. Needs prodantix.pages.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the pages belong to |
| pageId required | path | string | The page |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The page
{
"id": "string",
"name": "string",
"domain?": "string | null",
"path": "string",
"language": "string",
"translationGroup": "string",
"template": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"createdAt": "string",
"updatedAt": "string"
}No such page
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/archive" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/archive', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/archive'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/archive",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a landing page's report
Views and visitors by day and variant; each variant's submissions, CTA clicks, submission rate, bounce rate and time on page; the top sources; and the variant ahead on submissions with whether its lead holds at 95%.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the pages belong to |
| pageId required | path | string | The page |
| days | query | string | The days counted back from today, up to 365 |
Responses
The report
{
"days": [
{
"day": "string",
"variant": "string",
"views": "integer",
"visitors": "integer"
}
],
"variants": [
{
"variant": "string",
"views": "integer",
"visitors": "integer",
"submissions": "integer",
"ctaClicks": "integer",
"submissionRate?": "number | null",
"bounceRate?": "number | null",
"averageSeconds?": "number | null"
}
],
"sources": [
{
"source": "string",
"views": "integer",
"visitors": "integer"
}
],
"submissionLead?": {
"variant": "string",
"rate": "number",
"isSignificant": "boolean"
}
}No such page
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/report" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/report', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/report'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/report",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read every landing page's numbers
Each page's views, visitors and submissions over the last days, for the pages list.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the pages belong to |
| days | query | string | The days counted back from today, up to 365 |
Responses
200 The pages' numbers
{
"pages": [
{
"pageId": "string",
"views": "integer",
"visitors": "integer",
"submissions": "integer"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/page-totals" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/page-totals', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/page-totals'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/page-totals",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the consent banner
The project's consent banner with its draft and published version, or null before one is saved. Needs prodantix.projects.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the banner belongs to |
Responses
200 The banner
{
"banner?": {
"id": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"geotargeting": "boolean",
"updatedAt": "string"
}
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/consent-banner" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/consent-banner', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/consent-banner'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/consent-banner",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Save the consent banner's draft
The layout, the categories asked, the texts per language, the region rules, the style and the privacy policy; a published banner keeps showing its version until the draft is published. A colour pair under 4.5:1 is refused. Needs prodantix.projects.update.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the banner belongs to |
Body
{
"definition": "unknown"
}Responses
The banner
{
"id": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"geotargeting": "boolean",
"updatedAt": "string"
}The banner does not read or is refused
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/consent-banner" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"definition":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/consent-banner', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"definition": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/consent-banner'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"definition":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/consent-banner",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"definition":"string"},
)Publish the consent banner
Freezes the draft as the next version and shows it; visitors who answered an older version are asked again only when it adds a category. Region rules apply on plans with consent_geotargeting; on others every visitor is asked first. Needs prodantix.projects.update.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the banner belongs to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The banner
{
"id": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"geotargeting": "boolean",
"updatedAt": "string"
}The draft is refused
The project has no banner yet
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/consent-banner/publish" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/consent-banner/publish', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/consent-banner/publish'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/consent-banner/publish",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Take the consent banner off
Stops showing the banner; its records stay. Needs prodantix.projects.update.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the banner belongs to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The banner
{
"id": "string",
"status": "string",
"draft": "unknown",
"publishedVersion?": "integer | null",
"geotargeting": "boolean",
"updatedAt": "string"
}The draft is refused
The project has no banner yet
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/consent-banner/unpublish" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/consent-banner/unpublish', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/consent-banner/unpublish'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/consent-banner/unpublish",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a person's consent
Every answer the person gave to the banner or on a form, the latest first; the latest banner answer is their current consent.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the banner belongs to |
| distinctId required | path | string | The person |
Responses
200 The records
{
"consents": [
{
"id": "string",
"analytics?": "boolean | null",
"marketing?": "boolean | null",
"functional?": "boolean | null",
"source": "string",
"bannerVersion?": "integer | null",
"formId?": "string | null",
"purposes": [],
"regionRule": "string",
"pageUrl": "string",
"createdAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/consents" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/consents', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/consents'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/consents",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Erase an end user
Permanently erases one end user from the project: their profile, events, recordings, conversations and every alias linked to them. The distinct id goes in the body, so no log keeps it. Answers 202 with the queued job; asking again for the same person while a job runs answers that job.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the end user belongs to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"distinctId": "string",
"callbackUrl?": "string | null"
}Responses
The erasure job
{
"id": "string",
"projectId": "string",
"status": "string",
"counts": "unknown",
"requestedAt": "string",
"finishedAt?": "string | null"
}The caller may not erase or export end users
The project, the erasure or the export is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/erasures" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"distinctId":"string","callbackUrl":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/erasures', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"distinctId": "string",
"callbackUrl": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/erasures'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"distinctId":"string","callbackUrl":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/erasures",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"distinctId":"string","callbackUrl":"string"},
)Read an erasure
Where an erasure stands: queued, erasing, waiting for the analytics delete, done or failed, with what each store removed. A finished job no longer names the person.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the erasure ran in |
| erasureId required | path | string | The id the erase request answered |
Responses
The erasure job
{
"id": "string",
"projectId": "string",
"status": "string",
"counts": "unknown",
"requestedAt": "string",
"finishedAt?": "string | null"
}The caller may not erase or export end users
The project, the erasure or the export is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/erasures/:erasureId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/erasures/:erasureId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/erasures/:erasureId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/erasures/:erasureId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Export an end user's data
Builds one archive of everything held about one end user in the project: profile, sessions, groups, cohorts, messages, conversations, CRM notes, activities and tasks, events and recordings, across every alias linked to them. The distinct id goes in the body. Answers 202 with the queued export; asking again for the same person while one builds answers that export.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the end user belongs to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"distinctId": "string",
"callbackUrl?": "string | null"
}Responses
The export
{
"id": "string",
"projectId": "string",
"status": "string",
"bytes?": "integer | null",
"failure?": "string | null",
"requestedAt": "string",
"readyAt?": "string | null",
"expiresAt?": "string | null"
}The caller may not erase or export end users
The project, the erasure or the export is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/exports/people" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"distinctId":"string","callbackUrl":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/exports/people', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"distinctId": "string",
"callbackUrl": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/exports/people'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"distinctId":"string","callbackUrl":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/exports/people",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"distinctId":"string","callbackUrl":"string"},
)Read an end-user export
Where an export stands: queued, building, ready (with its size and when it is deleted), failed or expired.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the export ran in |
| exportId required | path | string | The id the export request answered |
Responses
The export
{
"id": "string",
"projectId": "string",
"status": "string",
"bytes?": "integer | null",
"failure?": "string | null",
"requestedAt": "string",
"readyAt?": "string | null",
"expiresAt?": "string | null"
}The caller may not erase or export end users
The project, the erasure or the export is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/exports/people/:exportId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/exports/people/:exportId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/exports/people/:exportId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/exports/people/:exportId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Link to an end-user export
A link that downloads the ready archive, valid for a minute.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the export ran in |
| exportId required | path | string | The id the export request answered |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The download link
{
"url": "string",
"expiresInSeconds": "integer"
}The caller may not erase or export end users
The project, the erasure or the export is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/exports/people/:exportId/link" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/exports/people/:exportId/link', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/exports/people/:exportId/link'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/exports/people/:exportId/link",
headers={"Authorization": f"Bearer {bearer_auth}"},
)deals
List pipelines
The project's pipelines and their stages with each stage's deal count; the first read gives a project its default pipeline. Needs prodantix.deals.read and deals in the plan.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
List pipelines
{
"pipelines": [
{
"id": "string",
"name": "string",
"position": "integer",
"stages": [
{
"id": "string",
"name": "string",
"position": "integer",
"probability": "integer",
"kind": "string",
"deals": "integer"
}
]
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/pipelines" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/pipelines', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/pipelines'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/pipelines",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a pipeline
A pipeline with its ordered stages: at least one open, one won and one lost. Refused past the plan's pipeline cap. Needs prodantix.pipelines.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"stages": [
{
"id?": "string | null",
"name": "string",
"probability": "integer",
"kind": "string"
}
]
}Responses
Create a pipeline
{
"id": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/pipelines" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","stages":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/pipelines', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"stages": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/pipelines'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","stages":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/pipelines",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","stages":[]},
)Change a pipeline
Renames the pipeline or replaces its stages; a stage named by id keeps its deals, a stage left out must hold none.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| pipelineId required | path | string | The pipeline |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name?": "string | null",
"stages?": [
{
"id?": "string | null",
"name": "string",
"probability": "integer",
"kind": "string"
}
]
}Responses
Change a pipeline
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/:pipelineId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","stages":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/:pipelineId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"stages": []
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/:pipelineId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","stages":[]}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/:pipelineId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","stages":[]},
)Delete a pipeline
Removes the pipeline, its deals moved first to a stage of another pipeline; a project keeps one pipeline.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| pipelineId required | path | string | The pipeline |
| moveTo | query | string | The stage its deals move to, when it holds any |
Responses
Delete a pipeline
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/:pipelineId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/:pipelineId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/:pipelineId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/:pipelineId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Order pipelines
Puts the project's pipelines in the order given.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"pipelineIds": []
}Responses
Order pipelines
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/order" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"pipelineIds":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/order', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"pipelineIds": []
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/order'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"pipelineIds":[]}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/order",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"pipelineIds":[]},
)Delete a stage
Removes the stage, its deals moved first to another stage of the same pipeline.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| stageId required | path | string | The stage |
| moveTo | query | string | The stage its deals move to, when it holds any |
Responses
Delete a stage
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/pipeline-stages/:stageId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/pipeline-stages/:stageId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/pipeline-stages/:stageId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/pipeline-stages/:stageId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the reporting currency
The currency deal reports convert into.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
Read the reporting currency
{
"currency": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/reporting-currency" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/reporting-currency', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/reporting-currency'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/reporting-currency",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Change the reporting currency
Open deals convert at today's rate; closed deals keep their closing rate re-based through today's cross rate. Needs prodantix.pipelines.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"currency": "string"
}Responses
Change the reporting currency
{
"currency": "string"
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/crm/reporting-currency" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"currency":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/reporting-currency', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"currency": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/reporting-currency'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"currency":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/crm/reporting-currency",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"currency":"string"},
)List deals
Deals newest first, optionally of one pipeline, stage or owner, or by name, after a cursor.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| pipelineId | query | string | Only this pipeline's deals |
| stageId | query | string | Only this stage's deals |
| owner | query | string | Only this owner's deals |
| search | query | string | Deals whose name contains this |
| afterUpdatedAt | query | string | The cursor's time |
| afterId | query | string | The cursor's deal |
| limit | query | string | At most this many, up to 500 |
Responses
List deals
{
"deals": [
{
"id": "string",
"pipelineId": "string",
"stageId": "string",
"name": "string",
"amount?": "string | null",
"currency": "string",
"closeDate?": "string | null",
"owner?": "string | null",
"lostReason?": "string | null",
"properties": "unknown",
"closedAt?": "string | null",
"closeRate?": "string | null",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string",
"reportingAmount?": "string | null",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string",
"isPrimary": "boolean"
}
]
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/deals" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/deals', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/deals'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/deals",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a deal
A deal on a stage, checked against the project's deal definitions, owned by its creator unless it names another, with any people and companies; the first company is primary.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"pipelineId": "string",
"stageId": "string",
"deal": {
"name?": "string | null",
"amount?": "string | null",
"currency?": "string | null",
"closeDate?": "string | null",
"owner?": "string | null",
"lostReason?": "string | null",
"properties?": "unknown"
},
"records?": [
{
"object": "string",
"groupType?": "string",
"subject": "string"
}
]
}Responses
Create a deal
{
"id": "string",
"pipelineId": "string",
"stageId": "string",
"name": "string",
"amount?": "string | null",
"currency": "string",
"closeDate?": "string | null",
"owner?": "string | null",
"lostReason?": "string | null",
"properties": "unknown",
"closedAt?": "string | null",
"closeRate?": "string | null",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string",
"reportingAmount?": "string | null",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string",
"isPrimary": "boolean"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/deals" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"pipelineId":"string","stageId":"string","deal":"string","records":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/deals', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"pipelineId": "string",
"stageId": "string",
"deal": "string",
"records": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/deals'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"pipelineId":"string","stageId":"string","deal":"string","records":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/deals",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"pipelineId":"string","stageId":"string","deal":"string","records":[]},
)Read a deal
One deal with its people and companies.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| dealId required | path | string | The deal |
Responses
Read a deal
{
"id": "string",
"pipelineId": "string",
"stageId": "string",
"name": "string",
"amount?": "string | null",
"currency": "string",
"closeDate?": "string | null",
"owner?": "string | null",
"lostReason?": "string | null",
"properties": "unknown",
"closedAt?": "string | null",
"closeRate?": "string | null",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string",
"reportingAmount?": "string | null",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string",
"isPrimary": "boolean"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Change a deal
Writes the fields named; custom properties merge and a null clears one.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| dealId required | path | string | The deal |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name?": "string | null",
"amount?": "string | null",
"currency?": "string | null",
"closeDate?": "string | null",
"owner?": "string | null",
"lostReason?": "string | null",
"properties?": "unknown"
}Responses
Change a deal
{
"id": "string",
"pipelineId": "string",
"stageId": "string",
"name": "string",
"amount?": "string | null",
"currency": "string",
"closeDate?": "string | null",
"owner?": "string | null",
"lostReason?": "string | null",
"properties": "unknown",
"closedAt?": "string | null",
"closeRate?": "string | null",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string",
"reportingAmount?": "string | null",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string",
"isPrimary": "boolean"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","amount":"string","currency":"string","closeDate":"string","owner":"string","lostReason":"string","properties":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"amount": "string",
"currency": "string",
"closeDate": "string",
"owner": "string",
"lostReason": "string",
"properties": "string"
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","amount":"string","currency":"string","closeDate":"string","owner":"string","lostReason":"string","properties":"string"}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","amount":"string","currency":"string","closeDate":"string","owner":"string","lostReason":"string","properties":"string"},
)Delete a deal
Removes the deal with its associations and history.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| dealId required | path | string | The deal |
Responses
Delete a deal
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Move a deal
Moves the deal to a stage: a won or lost stage closes it and fixes its rate, an open one reopens it. Produces $deal_stage_changed.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| dealId required | path | string | The deal |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"pipelineId": "string",
"stageId": "string",
"lostReason?": "string | null"
}Responses
Move a deal
{
"id": "string",
"pipelineId": "string",
"stageId": "string",
"name": "string",
"amount?": "string | null",
"currency": "string",
"closeDate?": "string | null",
"owner?": "string | null",
"lostReason?": "string | null",
"properties": "unknown",
"closedAt?": "string | null",
"closeRate?": "string | null",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string",
"reportingAmount?": "string | null",
"records": [
{
"object": "string",
"groupType": "string",
"subject": "string",
"isPrimary": "boolean"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/move" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"pipelineId":"string","stageId":"string","lostReason":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/move', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"pipelineId": "string",
"stageId": "string",
"lostReason": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/move'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"pipelineId":"string","stageId":"string","lostReason":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/move",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"pipelineId":"string","stageId":"string","lostReason":"string"},
)Associate a record
Associates a person or a company with the deal; the deal's first company is primary.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| dealId required | path | string | The deal |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"object": "string",
"groupType?": "string",
"subject": "string"
}Responses
Associate a record
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/records" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","subject":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/records', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"subject": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/records'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","subject":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/records",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","subject":"string"},
)Dissociate a record
Removes the association; removing the primary company promotes the earliest other.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| dealId required | path | string | The deal |
Body
{
"object": "string",
"groupType?": "string",
"subject": "string"
}Responses
Dissociate a record
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/records" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"object":"string","groupType":"string","subject":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/records', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"object": "string",
"groupType": "string",
"subject": "string"
}),
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/records'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"object":"string","groupType":"string","subject":"string"}),
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/records",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"object":"string","groupType":"string","subject":"string"},
)Make a company primary
Marks one of the deal's companies primary.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| dealId required | path | string | The deal |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"groupType": "string",
"groupKey": "string"
}Responses
Make a company primary
The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/primary" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"groupType":"string","groupKey":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/primary', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"groupType": "string",
"groupKey": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/primary'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"groupType":"string","groupKey":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId/primary",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"groupType":"string","groupKey":"string"},
)Read deal reports
Pipeline value raw and weighted per stage, win rate by count and amount, days in each stage and to close, forecast by close month, and deals created and closed per week, in the reporting currency.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| pipelineId required | query | string | The pipeline |
| owner | query | string | Only this owner's deals |
| since | query | string | Closed deals and moves from this RFC 3339 time; 90 days back by default |
Responses
Read deal reports
{
"currency": "string",
"stages": [
{
"stageId": "string",
"count": "integer",
"amount": "string",
"weighted": "string"
}
],
"leftOut": "integer",
"won": "integer",
"lost": "integer",
"wonAmount": "string",
"lostAmount": "string",
"winRateByCount?": "number | null",
"winRateByAmount?": "number | null",
"daysInStage": [
{
"stageId": "string",
"days": "number"
}
],
"daysToClose?": "number | null",
"forecast": [
{
"month?": "string | null",
"weighted": "string"
}
],
"weeks": [
{
"week": "string",
"created": "integer",
"closed": "integer"
}
]
}The request is not one the CRM can take; error.fields names each refused value and the rule it broke
The caller may not do this
The project or the thing named is not there
The name is taken
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/deal-reports" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/crm/deal-reports', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/crm/deal-reports'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/crm/deal-reports",
headers={"Authorization": f"Bearer {bearer_auth}"},
)messenger
Read the help centre
The company's Clepit help site as the messenger reads it (its address, how many articles and in which languages, when they were last read and why the last read failed) and whether this project's visitors can search its articles.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project whose messenger this is |
Responses
The help centre and the project's article search
{
"site?": {
"url": "string",
"articles": "integer",
"languages": [],
"lastReadAt?": "string | null",
"readError?": "string | null",
"capped": "boolean"
},
"search": {
"on": "boolean",
"placement": "tab | first_view | while_typing"
}
}The caller may not do this
The project is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Look the help site up again
Asks Clepit which site belongs to the company and stores, moves or clears it, then answers as the read does. Use it after setting the help site up in Clepit.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project whose messenger this is |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The help centre after the lookup
{
"site?": {
"url": "string",
"articles": "integer",
"languages": [],
"lastReadAt?": "string | null",
"readError?": "string | null",
"capped": "boolean"
},
"search": {
"on": "boolean",
"placement": "tab | first_view | while_typing"
}
}The caller may not do this
The project is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/refresh" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/refresh', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/refresh'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/refresh",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Set article search
Lets visitors search the help centre's articles in the messenger, and where they find them: tab, first_view or while_typing. Turning it on needs a plan with article search, and answers 402 otherwise.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project whose messenger this is |
Body
{
"on": "boolean",
"placement": "tab | first_view | while_typing"
}Responses
The article search as stored
{
"on": "boolean",
"placement": "tab | first_view | while_typing"
}The caller may not do this
The project is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/messenger/article-search" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"on":true,"placement":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/messenger/article-search', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"on": true,
"placement": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/messenger/article-search'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"on":true,"placement":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/messenger/article-search",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"on":true,"placement":"string"},
)Report the help articles
Each help article's site views, messenger opens, reader faces from the messenger and the help site, satisfaction, conversations started from it and assistant citations over the range, most read first. A range spans at most 400 days.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project whose messenger this is |
| from required | query | string | An RFC 3339 time; the range includes from and excludes to. |
| to required | query | string | An RFC 3339 time; the range includes from and excludes to. |
Responses
The articles
[
{
"pageId": "string",
"title": "string",
"url": "string",
"trail": "unknown",
"siteViews30d": "integer",
"messengerOpens": "integer",
"messengerFaces": {
"disappointed": "integer",
"neutral": "integer",
"smiley": "integer"
},
"siteFaces?": {
"disappointed": "integer",
"neutral": "integer",
"smiley": "integer"
},
"satisfaction?": "number | null",
"conversationsStarted": "integer",
"citations": "integer"
}
]The caller may not do this
The project is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/articles" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/articles', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/articles'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/articles",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the articles to write
What visitors asked over the last 30 days that no article answered, grouped weekly into suggested articles when the company has the AI add-on and listed as asked otherwise. Needs the permission to read conversations as well as the messenger.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project whose messenger this is |
Responses
The latest grouping
{
"computedAt?": "string | null",
"grouped": "boolean",
"topics": [
{
"title?": "string | null",
"questions": [],
"conversations": "integer"
}
]
}The caller may not do this
The project is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/gaps" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/gaps', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/gaps'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/gaps",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Translate messenger texts
Translates the messenger's texts from one language (from, a BCP 47 tag) into another (to) with AI, one translation per text in order. A text may hold the inline markup a starter prompt carries, which comes back as it went. Up to 4000 bytes a text and 20,000 in all. Nothing is stored: write the result with the messenger's settings. Answers 402 with AI_DISABLED or AI_LIMIT_REACHED when the AI add-on is off or at a limit.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project whose messenger this is |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"from": "string",
"to": "string",
"texts": []
}Responses
One translation per text, in order
{
"texts": []
}The texts cannot be translated as sent
The AI add-on is off or at a limit
The caller may not do this
The project is not there
The AI provider failed or its reply could not be used
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/messenger/translations" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"from":"string","to":"string","texts":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/messenger/translations', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"from": "string",
"to": "string",
"texts": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/messenger/translations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"from":"string","to":"string","texts":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/messenger/translations",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"from":"string","to":"string","texts":[]},
)Read a project's messenger configuration
Returns the messenger's appearance, greeting and availability for the project the key belongs to, resolved for one locale. A project that has never been configured and one deliberately switched off both answer `{ "enabled": false }`; neither is a 404, because a 404 cannot be told apart from a wrong key.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| locale | query | string | BCP 47 language tags to resolve copy for, comma separated and in the visitor's own order of preference, as `Accept-Language` lists them. Each tag is tried exactly, then its primary subtag, then the project's own default language, then English. |
| accent | query | string | An accent the page sets in code, written `#rrggbb`, painted in place of the one saved in the console, with the text colours derived for it. A value that is not such a colour, or a project whose plan lacks messenger customization, keeps the saved accent and answers `accentRefusal`. |
Responses
The messenger configuration, or a disabled marker
{
"enabled": "boolean",
"launcherPosition": "string",
"launcherOffsetX": "integer",
"launcherOffsetY": "integer",
"accentColor": "string",
"onAccent": "string",
"accentInk": "string",
"accentInkDark": "string",
"accentRefusal?": "string | null",
"greeting": "string",
"awayMessage": "string",
"availability": "unknown",
"version": "string",
"skin": "string",
"launcherShape": "string",
"launcherFill": "string",
"launcherContent": "string",
"launcherSize": "string",
"bubbleShape": "string",
"bubbleFill": "string",
"composerShape": "string",
"namePlacement": "string",
"nameAvatar": "boolean",
"dayDividers": "boolean",
"stampPlacement": "string",
"stampContent": "string",
"starterPrompts": [
{
"html": "string",
"text": "string"
}
],
"team": [
{
"name": "string",
"initials": "string",
"tone": "string",
"avatarUrl?": "string | null"
}
],
"socketUrl": "string",
"attachments": {
"enabled": "boolean",
"maxBytes": "integer",
"accept": [],
"words": {
"refused": "string",
"unchecked": "string",
"tryAgain": "string"
}
},
"help?": {
"placement": "string",
"words": {
"messagesTab": "string",
"helpTab": "string",
"searchPlaceholder": "string",
"collections": "string",
"mostRead": "string",
"mightHelp": "string",
"noMatches": "string",
"back": "string",
"openOnSite": "string",
"stillNeedHelp": "string",
"messageUs": "string",
"readOnSite": "string",
"wasItHelpful": "string",
"thanks": "string",
"smiley": "string",
"neutral": "string",
"disappointed": "string",
"rateArticle": "string"
}
},
"tickets?": {
"words": {
"messagesTab": "string",
"ticketsTab": "string",
"yourTickets": "string",
"noTickets": "string",
"openTicket": "string",
"whatYouNeed": "string",
"subject": "string",
"choose": "string",
"send": "string",
"repliesHere": "string",
"reply": "string",
"back": "string",
"failed": "string",
"updated": "string",
"asked": "string",
"closed": "string"
}
},
"whiteLabel": "boolean",
"poweredBy?": "string | null"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The configuration could not be read
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/messenger/config" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/messenger/config', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/messenger/config'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/messenger/config",
headers={"Authorization": f"Bearer {project_key}"},
)Read a team member's picture
Serves the picture a team member uploaded for the messenger, at the path the config's `team` and a turn's `authorAvatarUrl` name. The bytes are content-addressed and never change under a path, so a browser may cache them for a day. An `<img>` cannot set a header, so the project key may travel as the `api_key` query parameter instead of the bearer.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| user_id required | path | string | The person the picture belongs to. |
| file required | path | string | The picture's content hash and extension. |
| api_key | query | string | The public project key, for a load that cannot set the bearer header. |
Responses
The picture, as PNG, JPEG, WebP or SVG
Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}No picture at this path
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The picture could not be read from storage
{
"statusCode": "integer",
"message": "string",
"error": "string"
}This deployment has no picture storage
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/messenger/avatar/:user_id/:file" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/messenger/avatar/:user_id/:file', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/messenger/avatar/:user_id/:file'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/messenger/avatar/:user_id/:file",
headers={"Authorization": f"Bearer {project_key}"},
)Search a project's help centre
Answers up to five help centre articles matching `q`, each page once, in the visitor's language first, or with `collection` the articles of that top-level collection by title. One of the two is required. A project with article search off or no help centre connected answers an empty list. Words past 200 characters are ignored.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| q | query | string | The words to search for. |
| collection | query | string | A top-level collection's title, as the collections read names it, to list its articles instead. |
| lang | query | string | The visitor's language as a BCP 47 tag. Articles in its primary subtag come first, then the help centre's own default language. |
| user_id | query | string | The signed-in visitor's id, sent with user_hash. A verified pair also answers the articles kept for signed-in readers. |
| user_hash | query | string | HMAC-SHA256 of user_id under the project's signing secret, as the messenger's identify sends it. A pair that does not verify answers the public articles only. |
Responses
The matching articles, best first
{
"articles": [
{
"id": "string",
"title": "string",
"trail": [],
"url": "string",
"embedUrl": "string",
"pageId": "string",
"language": "string"
}
]
}No search words were given
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many requests from this project or address
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The help centre could not be read
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/messenger/articles" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/messenger/articles', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/messenger/articles'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/messenger/articles",
headers={"Authorization": f"Bearer {project_key}"},
)Read a project's most read help articles
Answers the three help centre articles read most over the last 30 days, in the visitor's language first. A project with article search off or no help centre connected answers an empty list.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| lang | query | string | The visitor's language as a BCP 47 tag. Articles in its primary subtag come first, then the help centre's own default language. |
| user_id | query | string | The signed-in visitor's id, sent with user_hash. A verified pair also answers the articles kept for signed-in readers. |
| user_hash | query | string | HMAC-SHA256 of user_id under the project's signing secret, as the messenger's identify sends it. A pair that does not verify answers the public articles only. |
Responses
The most read articles
{
"articles": [
{
"id": "string",
"title": "string",
"trail": [],
"url": "string",
"embedUrl": "string",
"pageId": "string",
"language": "string"
}
]
}No search words were given
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many requests from this project or address
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The help centre could not be read
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/messenger/articles/popular" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/messenger/articles/popular', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/messenger/articles/popular'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/messenger/articles/popular",
headers={"Authorization": f"Bearer {project_key}"},
)Read a project's help centre collections
Answers the help centre's top-level collections with how many articles each holds, each page counted once in the visitor's language first. A project with article search off or no help centre connected answers an empty list.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| lang | query | string | The visitor's language as a BCP 47 tag. Articles in its primary subtag come first, then the help centre's own default language. |
| user_id | query | string | The signed-in visitor's id, sent with user_hash. A verified pair also answers the articles kept for signed-in readers. |
| user_hash | query | string | HMAC-SHA256 of user_id under the project's signing secret, as the messenger's identify sends it. A pair that does not verify answers the public articles only. |
Responses
The collections, by title
{
"collections": [
{
"title": "string",
"articles": "integer"
}
]
}No search words were given
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many requests from this project or address
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The help centre could not be read
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/messenger/articles/collections" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/messenger/articles/collections', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/messenger/articles/collections'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/messenger/articles/collections",
headers={"Authorization": f"Bearer {project_key}"},
)Read the address to frame a help article at
Answers the embed address of the article in the visitor's language first. An article kept for signed-in readers answers only to a verified visitor, and its address carries a one-use reader ticket good for sixty seconds.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| pageId required | path | string | The article's page id, as the article reads name it. |
| lang | query | string | The visitor's language as a BCP 47 tag. Articles in its primary subtag come first, then the help centre's own default language. |
| user_id | query | string | The signed-in visitor's id, sent with user_hash. A verified pair also answers the articles kept for signed-in readers. |
| user_hash | query | string | HMAC-SHA256 of user_id under the project's signing secret, as the messenger's identify sends it. A pair that does not verify answers the public articles only. |
Responses
The address to frame the article at
{
"url": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}No such article for this visitor: it does not exist, or it is kept for signed-in readers and the visitor is not verified
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many requests from this project or address
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The help centre could not be read
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The help centre refused a reader ticket for a private article
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/messenger/articles/:pageId/frame" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/messenger/articles/:pageId/frame', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/messenger/articles/:pageId/frame'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/messenger/articles/:pageId/frame",
headers={"Authorization": f"Bearer {project_key}"},
)Rate a help article
Records a reader's face for a help article read in the messenger: disappointed, neutral or smiley. One per reader per article; a second replaces the first.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| pageId required | path | string | The help centre page, by the id the article reads answered. |
Body
{
"distinctId": "string",
"language": "string",
"reaction": "string"
}Responses
Recorded
A field is missing, too long or not one of its allowed values
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The project searches no help centre holding this page
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many requests from this project or address
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The reaction could not be recorded
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://api.prodantix.com/v1/messenger/articles/:pageId/reaction" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"distinctId":"string","language":"string","reaction":"string"}'const response = await fetch('https://api.prodantix.com/v1/messenger/articles/:pageId/reaction', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"distinctId": "string",
"language": "string",
"reaction": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/messenger/articles/:pageId/reaction'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"distinctId":"string","language":"string","reaction":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/messenger/articles/:pageId/reaction",
headers={"Authorization": f"Bearer {project_key}"},
json={"distinctId":"string","language":"string","reaction":"string"},
)Count a help article read in the messenger
Counts one opening of a help article in the messenger's reader, for the article report.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| pageId required | path | string | The help centre page, by the id the article reads answered. |
Body
{
"language": "string",
"distinctId?": "string | null"
}Responses
Recorded
A field is missing, too long or not one of its allowed values
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The project searches no help centre holding this page
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many requests from this project or address
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The reaction could not be recorded
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://api.prodantix.com/v1/messenger/articles/:pageId/opened" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"language":"string","distinctId":"string"}'const response = await fetch('https://api.prodantix.com/v1/messenger/articles/:pageId/opened', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"language": "string",
"distinctId": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/messenger/articles/:pageId/opened'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"language":"string","distinctId":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/messenger/articles/:pageId/opened",
headers={"Authorization": f"Bearer {project_key}"},
json={"language":"string","distinctId":"string"},
)company
Read the single sign-on connection
The company's identity provider, OIDC or SAML, without its client secret, which is never stored here. Answers 404 when none is connected.
Responses
The connection
{
"id": "string",
"protocol": "string",
"displayName": "string",
"issuer?": "string | null",
"clientId?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The company's plan does not include single sign-on
The caller may not manage the company's security
Try it
curl -X GET "https://api.prodantix.com/v1/company/sso" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/sso', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/company/sso'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/company/sso",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Connect an identity provider
Connects the company's identity provider, replacing the one connected before. OIDC takes an https issuer, a client id and a client secret; SAML takes federation metadata of at most 512 KiB.
Body
{
"displayName": "string",
"protocol": "string",
"issuer?": "string | null",
"clientId?": "string | null",
"clientSecret?": "string | null",
"metadataXml?": "string | null"
}Responses
The connection as stored
{
"id": "string",
"protocol": "string",
"displayName": "string",
"issuer?": "string | null",
"clientId?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The company's plan does not include single sign-on
The caller may not manage the company's security
Try it
curl -X PUT "https://api.prodantix.com/v1/company/sso" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"displayName":"string","protocol":"string","issuer":"string","clientId":"string","clientSecret":"string","metadataXml":"string"}'const response = await fetch('https://api.prodantix.com/v1/company/sso', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"displayName": "string",
"protocol": "string",
"issuer": "string",
"clientId": "string",
"clientSecret": "string",
"metadataXml": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/company/sso'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"displayName":"string","protocol":"string","issuer":"string","clientId":"string","clientSecret":"string","metadataXml":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/company/sso",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"displayName":"string","protocol":"string","issuer":"string","clientId":"string","clientSecret":"string","metadataXml":"string"},
)Disconnect the identity provider
Disconnects the company's identity provider; its people sign in with their Bomdisoft ID again. Anyone signed in stays signed in.
Responses
The provider is disconnected
The company's plan does not include single sign-on
The caller may not manage the company's security
Try it
curl -X DELETE "https://api.prodantix.com/v1/company/sso" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/sso', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/company/sso'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/company/sso",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the company's closure
When the company closed, why, and when it is deleted; `closure` is null while it is open.
Responses
200 The closure
{
"closure?": {
"closedAt": "string",
"purgeAfter": "string",
"reason": "string"
}
}Try it
curl -X GET "https://api.prodantix.com/v1/company/closure" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/closure', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/company/closure'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/company/closure",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Close the company
Closes the company at once: it stops, stays exportable and reopenable for 30 days, and is then deleted with everything in it. Owners only, after a fresh two-factor sign-in carried in `x-id-token`.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The closure
{
"closedAt": "string",
"purgeAfter": "string",
"reason": "string"
}A fresh two-factor sign-in is required (`STEP_UP_REQUIRED`)
The caller is not an owner
Try it
curl -X POST "https://api.prodantix.com/v1/company/close" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/close', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/company/close'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/company/close",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Reopen the company
Reopens a closed company within its 30 days. Owners only, after a fresh two-factor sign-in carried in `x-id-token`.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
Reopened
A fresh two-factor sign-in is required (`STEP_UP_REQUIRED`)
The caller is not an owner
The company is not closed, or its 30 days have run out
Try it
curl -X POST "https://api.prodantix.com/v1/company/reopen" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/reopen', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/company/reopen'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/company/reopen",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the company's export
The latest export of everything, or null when none was asked for. Owners only.
Responses
The export
{
"export?": {
"id": "string",
"status": "string",
"bytes?": "integer | null",
"requestedAt": "string",
"readyAt?": "string | null",
"expiresAt?": "string | null"
}
}The caller is not an owner
Try it
curl -X GET "https://api.prodantix.com/v1/company/export" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/export', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/company/export'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/company/export",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Export everything
Starts preparing one archive of everything the company holds: every record, its events and its session recordings. Answers the export already being prepared rather than starting a second. Owners only.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The export
{
"id": "string",
"status": "string",
"bytes?": "integer | null",
"requestedAt": "string",
"readyAt?": "string | null",
"expiresAt?": "string | null"
}The caller is not an owner
Try it
curl -X POST "https://api.prodantix.com/v1/company/export" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/export', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/company/export'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/company/export",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Link to the company's export
A link that downloads the ready archive, valid for a minute. Owners only.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| exportId required | path | string | The id the export request answered |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The link
{
"url": "string",
"expiresInSeconds": "integer"
}The caller is not an owner
The export is not ready, or its 7 days have run out
Try it
curl -X POST "https://api.prodantix.com/v1/company/export/:exportId/link" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/export/:exportId/link', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/company/export/:exportId/link'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/company/export/:exportId/link",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List a project's domains
The project environment's tracking domain, then its content domains, each with the DNS records to add and its state.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project environment the domains belong to |
Responses
200 The domains
{
"domains": [
{
"id": "string",
"name": "string",
"status": "string",
"records": [
{
"purpose": "string",
"recordType": "string",
"name": "string",
"value": "string",
"priority?": "integer | null",
"status": "string"
}
],
"trackingSubdomain": "string",
"openTracking": "boolean",
"clickTracking": "boolean",
"dmarcSeen": "boolean",
"dedicatedPool": "string",
"lastError?": "string | null",
"checkedAt?": "string | null",
"verifiedAt?": "string | null",
"createdAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/domains" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/domains', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/domains'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/domains",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Connect a domain
Claims a subdomain for tracking (the SDK's ingest, flags and messenger) or content (hosted forms and pages), and answers the TXT record that proves the project controls it. Counted against the plan's max_first_party_domains. Needs prodantix.projects.update.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project environment the domains belong to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"domain": "string",
"purpose": "string"
}Responses
The claimed domain
{
"id": "string",
"domain": "string",
"purpose": "string",
"state": "string",
"records": [
{
"purpose": "string",
"recordType": "string",
"name": "string",
"value": "string",
"priority?": "integer | null",
"status": "string"
}
],
"verifiedAt?": "string | null",
"servingAt?": "string | null",
"checkedAt?": "string | null",
"lastError?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The host is not a subdomain, or the purpose is unknown
The plan holds no more domains
The project already connects it, or the environment already has its tracking domain
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/domains" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"domain":"string","purpose":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/domains', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"domain": "string",
"purpose": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/domains'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"domain":"string","purpose":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/domains",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"domain":"string","purpose":"string"},
)Check a domain now
Looks for a claimed domain's TXT record now, rather than at the next ten-minute check. Needs prodantix.projects.update.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project environment the domains belong to |
| domainId required | path | string | The domain's id |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The domain as the check left it
{
"id": "string",
"domain": "string",
"purpose": "string",
"state": "string",
"records": [
{
"purpose": "string",
"recordType": "string",
"name": "string",
"value": "string",
"priority?": "integer | null",
"status": "string"
}
],
"verifiedAt?": "string | null",
"servingAt?": "string | null",
"checkedAt?": "string | null",
"lastError?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}No such domain
Another project proved this host first
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/domains/:domainId/check" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/domains/:domainId/check', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/domains/:domainId/check'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/domains/:domainId/check",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Remove a domain
The domain stops serving at once and is detached at the next pipeline run. Needs prodantix.projects.update.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project environment the domains belong to |
| domainId required | path | string | The domain's id |
Responses
The removed domain
{
"id": "string",
"domain": "string",
"purpose": "string",
"state": "string",
"records": [
{
"purpose": "string",
"recordType": "string",
"name": "string",
"value": "string",
"priority?": "integer | null",
"status": "string"
}
],
"verifiedAt?": "string | null",
"servingAt?": "string | null",
"checkedAt?": "string | null",
"lastError?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}No such domain
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/domains/:domainId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/domains/:domainId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/domains/:domainId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/domains/:domainId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)surveys
List surveys
A project's surveys that are not archived, most recently changed first.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the survey belongs to. |
Responses
The surveys
{
"surveys": [
{
"id": "string",
"name": "string",
"kind": "popover | api",
"status": "draft | running | stopped | archived",
"questions": [
{
"id": "string",
"kind": "open | single | multiple | nps | rating | emoji | link",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"scale?": "integer | null",
"link?": "string | null",
"optional?": "boolean",
"branches?": [
{
"choice?": "string | null",
"minScore?": "integer | null",
"maxScore?": "integer | null",
"next?": "string | null"
}
],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"appearance": {
"placement?": "bottom_right | bottom_left | bottom_center",
"accent?": "string | null",
"submitLabel?": "string | null",
"thankYou?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"language": "string",
"translations": [
{
"language": "string",
"questions": [
{
"id": "string",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"submitLabel?": "string | null",
"thankYou?": "string | null"
}
],
"repeatDays?": "integer | null",
"responseLimit?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}
]
}The survey is not valid
The caller may not do this
The project or survey is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/surveys" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/surveys', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/surveys'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/surveys",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a survey
Saves a draft survey: its questions, appearance, targeting and schedule.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the survey belongs to. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"kind": "popover | api",
"questions": [
{
"id": "string",
"kind": "open | single | multiple | nps | rating | emoji | link",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"scale?": "integer | null",
"link?": "string | null",
"optional?": "boolean",
"branches?": [
{
"choice?": "string | null",
"minScore?": "integer | null",
"maxScore?": "integer | null",
"next?": "string | null"
}
],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"appearance?": {
"placement?": "bottom_right | bottom_left | bottom_center",
"accent?": "string | null",
"submitLabel?": "string | null",
"thankYou?": "string | null"
},
"targeting?": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"language?": "string",
"translations?": [
{
"language": "string",
"questions": [
{
"id": "string",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"submitLabel?": "string | null",
"thankYou?": "string | null"
}
],
"repeatDays?": "integer | null",
"responseLimit?": "integer | null",
"startsAt?": "string | null",
"endsAt?": "string | null"
}Responses
The survey as saved
{
"id": "string",
"name": "string",
"kind": "popover | api",
"status": "draft | running | stopped | archived",
"questions": [
{
"id": "string",
"kind": "open | single | multiple | nps | rating | emoji | link",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"scale?": "integer | null",
"link?": "string | null",
"optional?": "boolean",
"branches?": [
{
"choice?": "string | null",
"minScore?": "integer | null",
"maxScore?": "integer | null",
"next?": "string | null"
}
],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"appearance": {
"placement?": "bottom_right | bottom_left | bottom_center",
"accent?": "string | null",
"submitLabel?": "string | null",
"thankYou?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"language": "string",
"translations": [
{
"language": "string",
"questions": [
{
"id": "string",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"submitLabel?": "string | null",
"thankYou?": "string | null"
}
],
"repeatDays?": "integer | null",
"responseLimit?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The survey is not valid
The caller may not do this
The project or survey is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/surveys" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","kind":"string","questions":[],"appearance":"string","targeting":"string","language":"string","translations":[],"repeatDays":0,"responseLimit":0,"startsAt":"string","endsAt":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/surveys', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"kind": "string",
"questions": [],
"appearance": "string",
"targeting": "string",
"language": "string",
"translations": [],
"repeatDays": 0,
"responseLimit": 0,
"startsAt": "string",
"endsAt": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/surveys'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","kind":"string","questions":[],"appearance":"string","targeting":"string","language":"string","translations":[],"repeatDays":0,"responseLimit":0,"startsAt":"string","endsAt":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/surveys",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","kind":"string","questions":[],"appearance":"string","targeting":"string","language":"string","translations":[],"repeatDays":0,"responseLimit":0,"startsAt":"string","endsAt":"string"},
)Read a survey
One survey with its questions, appearance, targeting and schedule.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the survey belongs to. |
| surveyId required | path | string | The survey. |
Responses
The survey
{
"id": "string",
"name": "string",
"kind": "popover | api",
"status": "draft | running | stopped | archived",
"questions": [
{
"id": "string",
"kind": "open | single | multiple | nps | rating | emoji | link",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"scale?": "integer | null",
"link?": "string | null",
"optional?": "boolean",
"branches?": [
{
"choice?": "string | null",
"minScore?": "integer | null",
"maxScore?": "integer | null",
"next?": "string | null"
}
],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"appearance": {
"placement?": "bottom_right | bottom_left | bottom_center",
"accent?": "string | null",
"submitLabel?": "string | null",
"thankYou?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"language": "string",
"translations": [
{
"language": "string",
"questions": [
{
"id": "string",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"submitLabel?": "string | null",
"thankYou?": "string | null"
}
],
"repeatDays?": "integer | null",
"responseLimit?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The survey is not valid
The caller may not do this
The project or survey is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Change a survey
Replaces a survey's name, questions, appearance, targeting and schedule.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the survey belongs to. |
| surveyId required | path | string | The survey. |
Body
{
"name": "string",
"kind": "popover | api",
"questions": [
{
"id": "string",
"kind": "open | single | multiple | nps | rating | emoji | link",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"scale?": "integer | null",
"link?": "string | null",
"optional?": "boolean",
"branches?": [
{
"choice?": "string | null",
"minScore?": "integer | null",
"maxScore?": "integer | null",
"next?": "string | null"
}
],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"appearance?": {
"placement?": "bottom_right | bottom_left | bottom_center",
"accent?": "string | null",
"submitLabel?": "string | null",
"thankYou?": "string | null"
},
"targeting?": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"language?": "string",
"translations?": [
{
"language": "string",
"questions": [
{
"id": "string",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"submitLabel?": "string | null",
"thankYou?": "string | null"
}
],
"repeatDays?": "integer | null",
"responseLimit?": "integer | null",
"startsAt?": "string | null",
"endsAt?": "string | null"
}Responses
The survey as saved
{
"id": "string",
"name": "string",
"kind": "popover | api",
"status": "draft | running | stopped | archived",
"questions": [
{
"id": "string",
"kind": "open | single | multiple | nps | rating | emoji | link",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"scale?": "integer | null",
"link?": "string | null",
"optional?": "boolean",
"branches?": [
{
"choice?": "string | null",
"minScore?": "integer | null",
"maxScore?": "integer | null",
"next?": "string | null"
}
],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"appearance": {
"placement?": "bottom_right | bottom_left | bottom_center",
"accent?": "string | null",
"submitLabel?": "string | null",
"thankYou?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"language": "string",
"translations": [
{
"language": "string",
"questions": [
{
"id": "string",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"submitLabel?": "string | null",
"thankYou?": "string | null"
}
],
"repeatDays?": "integer | null",
"responseLimit?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The survey is not valid
The caller may not do this
The project or survey is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","kind":"string","questions":[],"appearance":"string","targeting":"string","language":"string","translations":[],"repeatDays":0,"responseLimit":0,"startsAt":"string","endsAt":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"kind": "string",
"questions": [],
"appearance": "string",
"targeting": "string",
"language": "string",
"translations": [],
"repeatDays": 0,
"responseLimit": 0,
"startsAt": "string",
"endsAt": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","kind":"string","questions":[],"appearance":"string","targeting":"string","language":"string","translations":[],"repeatDays":0,"responseLimit":0,"startsAt":"string","endsAt":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","kind":"string","questions":[],"appearance":"string","targeting":"string","language":"string","translations":[],"repeatDays":0,"responseLimit":0,"startsAt":"string","endsAt":"string"},
)Start a survey
Shows the survey to the visitors it targets from its start time.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the survey belongs to. |
| surveyId required | path | string | The survey. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The running survey
{
"id": "string",
"name": "string",
"kind": "popover | api",
"status": "draft | running | stopped | archived",
"questions": [
{
"id": "string",
"kind": "open | single | multiple | nps | rating | emoji | link",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"scale?": "integer | null",
"link?": "string | null",
"optional?": "boolean",
"branches?": [
{
"choice?": "string | null",
"minScore?": "integer | null",
"maxScore?": "integer | null",
"next?": "string | null"
}
],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"appearance": {
"placement?": "bottom_right | bottom_left | bottom_center",
"accent?": "string | null",
"submitLabel?": "string | null",
"thankYou?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"language": "string",
"translations": [
{
"language": "string",
"questions": [
{
"id": "string",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"submitLabel?": "string | null",
"thankYou?": "string | null"
}
],
"repeatDays?": "integer | null",
"responseLimit?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The survey is not valid
The caller may not do this
The project or survey is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/start" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/start', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/start'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/start",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Stop a survey
Stops showing the survey; its results stay.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the survey belongs to. |
| surveyId required | path | string | The survey. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The stopped survey
{
"id": "string",
"name": "string",
"kind": "popover | api",
"status": "draft | running | stopped | archived",
"questions": [
{
"id": "string",
"kind": "open | single | multiple | nps | rating | emoji | link",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"scale?": "integer | null",
"link?": "string | null",
"optional?": "boolean",
"branches?": [
{
"choice?": "string | null",
"minScore?": "integer | null",
"maxScore?": "integer | null",
"next?": "string | null"
}
],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"appearance": {
"placement?": "bottom_right | bottom_left | bottom_center",
"accent?": "string | null",
"submitLabel?": "string | null",
"thankYou?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"language": "string",
"translations": [
{
"language": "string",
"questions": [
{
"id": "string",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"submitLabel?": "string | null",
"thankYou?": "string | null"
}
],
"repeatDays?": "integer | null",
"responseLimit?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The survey is not valid
The caller may not do this
The project or survey is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/stop" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/stop', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/stop'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/stop",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Archive a survey
Removes the survey from the list; its results stay in the events.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the survey belongs to. |
| surveyId required | path | string | The survey. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The archived survey
{
"id": "string",
"name": "string",
"kind": "popover | api",
"status": "draft | running | stopped | archived",
"questions": [
{
"id": "string",
"kind": "open | single | multiple | nps | rating | emoji | link",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"scale?": "integer | null",
"link?": "string | null",
"optional?": "boolean",
"branches?": [
{
"choice?": "string | null",
"minScore?": "integer | null",
"maxScore?": "integer | null",
"next?": "string | null"
}
],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"appearance": {
"placement?": "bottom_right | bottom_left | bottom_center",
"accent?": "string | null",
"submitLabel?": "string | null",
"thankYou?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"language": "string",
"translations": [
{
"language": "string",
"questions": [
{
"id": "string",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"submitLabel?": "string | null",
"thankYou?": "string | null"
}
],
"repeatDays?": "integer | null",
"responseLimit?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The survey is not valid
The caller may not do this
The project or survey is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/archive" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/archive', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/archive'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/archive",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Duplicate a survey
Saves a draft copy of a survey.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the survey belongs to. |
| surveyId required | path | string | The survey. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The copy
{
"id": "string",
"name": "string",
"kind": "popover | api",
"status": "draft | running | stopped | archived",
"questions": [
{
"id": "string",
"kind": "open | single | multiple | nps | rating | emoji | link",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"scale?": "integer | null",
"link?": "string | null",
"optional?": "boolean",
"branches?": [
{
"choice?": "string | null",
"minScore?": "integer | null",
"maxScore?": "integer | null",
"next?": "string | null"
}
],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"appearance": {
"placement?": "bottom_right | bottom_left | bottom_center",
"accent?": "string | null",
"submitLabel?": "string | null",
"thankYou?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"language": "string",
"translations": [
{
"language": "string",
"questions": [
{
"id": "string",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"submitLabel?": "string | null",
"thankYou?": "string | null"
}
],
"repeatDays?": "integer | null",
"responseLimit?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The survey is not valid
The caller may not do this
The project or survey is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/duplicate" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/duplicate', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/duplicate'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/duplicate",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a survey's results
Who saw, dismissed and answered a round of the survey, and the answers per question. `iteration` picks a round; the current one by default.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the survey belongs to. |
| surveyId required | path | string | The survey. |
| iteration | query | integer | The round to read. |
Responses
The results
{
"shown": "integer",
"dismissed": "integer",
"responses": "integer",
"questions": [
{
"questionId": "string",
"answered": "integer",
"choices": [
{
"choice": "string",
"count": "integer"
}
],
"nps?": {
"detractors": "integer",
"passives": "integer",
"promoters": "integer",
"score": "number"
},
"average?": "number | null",
"texts": []
}
]
}The survey is not valid
The caller may not do this
The project or survey is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/results" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/results', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/results'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/results",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Count each survey's responses
How many answers each of the project's surveys has received, over every round.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the survey belongs to. |
Responses
The counts, one per survey with any response
{
"surveys": [
{
"surveyId": "string",
"responses": "integer"
}
]
}The survey is not valid
The caller may not do this
The project or survey is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/surveys/responses" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/surveys/responses', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/surveys/responses'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/surveys/responses",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Translate survey texts
Translates a survey's words from one language (from, a BCP 47 tag) into another (to) with AI, one translation per text in order. Nothing is stored: put the result in the survey's translations and save it. Answers 402 with AI_DISABLED or AI_LIMIT_REACHED when the AI add-on is off or at a limit.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the survey belongs to. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"from": "string",
"to": "string",
"texts": []
}Responses
One translation per text, in order
{
"texts": []
}The survey is not valid
The caller may not do this
The project or survey is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/surveys/translations" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"from":"string","to":"string","texts":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/surveys/translations', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"from": "string",
"to": "string",
"texts": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/surveys/translations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"from":"string","to":"string","texts":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/surveys/translations",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"from":"string","to":"string","texts":[]},
)Read the surveys a visitor qualifies for
Answers the running surveys whose schedule, cohorts and flag the distinct id meets, with their questions, appearance and the page rules (addresses, trigger event, wait, show once) the SDK applies itself. A project with no running survey answers an empty list.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| distinct_id required | query | string | The visitor's distinct id. |
| lang | query | string | The visitor's language, a BCP 47 tag. A survey with words in it answers in it; otherwise in the language it was written in. |
Responses
The surveys the visitor qualifies for
{
"surveys": [
{
"id": "string",
"name": "string",
"kind": "popover | api",
"iteration": "integer",
"questions": [
{
"id": "string",
"kind": "open | single | multiple | nps | rating | emoji | link",
"prompt": "string",
"description?": "string | null",
"choices?": [],
"scale?": "integer | null",
"link?": "string | null",
"optional?": "boolean",
"branches?": [
{
"choice?": "string | null",
"minScore?": "integer | null",
"maxScore?": "integer | null",
"next?": "string | null"
}
],
"lowLabel?": "string | null",
"highLabel?": "string | null"
}
],
"choiceLabels": "object",
"appearance": {
"placement?": "bottom_right | bottom_left | bottom_center",
"accent?": "string | null",
"submitLabel?": "string | null",
"thankYou?": "string | null"
},
"urls": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"event?": "string | null",
"waitDays": "integer",
"showOnce": "boolean"
}
]
}The distinct id is missing or too long
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The surveys could not be read
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/surveys" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/surveys', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/surveys'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/surveys",
headers={"Authorization": f"Bearer {project_key}"},
)tickets
List tickets
A project's tickets, newest number first, filtered by state category, type, assignee, person, tracker, conversation or words in the title or number. Pages back with `before`, a ticket number.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| state | query | string | A state category: submitted, in_progress, waiting_on_customer or resolved. |
| typeId | query | string | A ticket type's id. |
| assignee | query | string | A member's id. |
| distinctId | query | string | The person's distinct id. |
| trackerId | query | string | A tracker ticket's id, to list the customer tickets linked to it. |
| conversationId | query | string | A conversation's id, to list the tickets opened from it. |
| q | query | string | Words in the title, or a ticket number. |
| before | query | string | List tickets numbered below this one. |
| limit | query | string | At most this many, up to 100. 50 when left out. |
Responses
The tickets
{
"tickets": [
{
"id": "string",
"number": "integer",
"typeId": "string",
"category": "customer | back_office | tracker",
"stateId": "string",
"stateCategory": "submitted | in_progress | waiting_on_customer | resolved",
"title": "string",
"priority": "low | normal | high | urgent",
"assigneeUserId?": "string | null",
"distinctId?": "string | null",
"conversationId?": "string | null",
"trackerId?": "string | null",
"mergedInto?": "string | null",
"attributes": "object",
"createdByKind": "member | visitor | api",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string",
"resolvedAt?": "string | null"
}
]
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/tickets" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/tickets', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/tickets'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/tickets",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a ticket
Opens a ticket of a type, numbered next in the project. A customer ticket names its person and may name the conversation it came from.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"typeId": "string",
"title": "string",
"priority?": "low | normal | high | urgent",
"stateId?": "string | null",
"assigneeUserId?": "string | null",
"distinctId?": "string | null",
"conversationId?": "string | null",
"attributes?": "object"
}Responses
The ticket as saved
{
"id": "string",
"number": "integer",
"typeId": "string",
"category": "customer | back_office | tracker",
"stateId": "string",
"stateCategory": "submitted | in_progress | waiting_on_customer | resolved",
"title": "string",
"priority": "low | normal | high | urgent",
"assigneeUserId?": "string | null",
"distinctId?": "string | null",
"conversationId?": "string | null",
"trackerId?": "string | null",
"mergedInto?": "string | null",
"attributes": "object",
"createdByKind": "member | visitor | api",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string",
"resolvedAt?": "string | null"
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/tickets" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"typeId":"string","title":"string","priority":"string","stateId":"string","assigneeUserId":"string","distinctId":"string","conversationId":"string","attributes":{}}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/tickets', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"typeId": "string",
"title": "string",
"priority": "string",
"stateId": "string",
"assigneeUserId": "string",
"distinctId": "string",
"conversationId": "string",
"attributes": {}
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/tickets'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"typeId":"string","title":"string","priority":"string","stateId":"string","assigneeUserId":"string","distinctId":"string","conversationId":"string","attributes":{}}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/tickets",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"typeId":"string","title":"string","priority":"string","stateId":"string","assigneeUserId":"string","distinctId":"string","conversationId":"string","attributes":{}},
)Read a ticket
One ticket by its id or its number.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| ticketId required | path | string | The ticket's id, or its number. |
Responses
The ticket
{
"id": "string",
"number": "integer",
"typeId": "string",
"category": "customer | back_office | tracker",
"stateId": "string",
"stateCategory": "submitted | in_progress | waiting_on_customer | resolved",
"title": "string",
"priority": "low | normal | high | urgent",
"assigneeUserId?": "string | null",
"distinctId?": "string | null",
"conversationId?": "string | null",
"trackerId?": "string | null",
"mergedInto?": "string | null",
"attributes": "object",
"createdByKind": "member | visitor | api",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string",
"resolvedAt?": "string | null"
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Change a ticket
Changes a ticket's title, priority, state, assignee or attribute values; a null attribute clears it. Every state, assignee and priority change is noted on its timeline. Resolving a tracker resolves the customer tickets linked to it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| ticketId required | path | string | The ticket's id, or its number. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"title?": "string | null",
"priority?": "Priority | null",
"stateId?": "string | null",
"assigneeUserId?": "string | null",
"unassign?": "boolean",
"attributes?": "object | null",
"typeId?": "string | null",
"distinctId?": "string | null"
}Responses
The ticket as saved
{
"id": "string",
"number": "integer",
"typeId": "string",
"category": "customer | back_office | tracker",
"stateId": "string",
"stateCategory": "submitted | in_progress | waiting_on_customer | resolved",
"title": "string",
"priority": "low | normal | high | urgent",
"assigneeUserId?": "string | null",
"distinctId?": "string | null",
"conversationId?": "string | null",
"trackerId?": "string | null",
"mergedInto?": "string | null",
"attributes": "object",
"createdByKind": "member | visitor | api",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string",
"resolvedAt?": "string | null"
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"title":"string","priority":"string","stateId":"string","assigneeUserId":"string","unassign":true,"attributes":{},"typeId":"string","distinctId":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"title": "string",
"priority": "string",
"stateId": "string",
"assigneeUserId": "string",
"unassign": true,
"attributes": {},
"typeId": "string",
"distinctId": "string"
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"title":"string","priority":"string","stateId":"string","assigneeUserId":"string","unassign":true,"attributes":{},"typeId":"string","distinctId":"string"}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"title":"string","priority":"string","stateId":"string","assigneeUserId":"string","unassign":true,"attributes":{},"typeId":"string","distinctId":"string"},
)Read a ticket's timeline
A ticket's internal notes and the changes made to it, oldest first. Never shown to the customer.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| ticketId required | path | string | The ticket's id, or its number. |
Responses
The timeline
{
"notes": [
{
"id": "string",
"kind": "string",
"authorKind": "string",
"authorId?": "string | null",
"body?": "string | null",
"data": "unknown",
"createdAt": "string"
}
]
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/notes" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/notes', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/notes'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/notes",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add a note to a ticket
Adds an internal note to a ticket's timeline.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| ticketId required | path | string | The ticket's id, or its number. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"body": "string"
}Responses
The note
{
"id": "string",
"kind": "string",
"authorKind": "string",
"authorId?": "string | null",
"body?": "string | null",
"data": "unknown",
"createdAt": "string"
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/notes" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"body":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/notes', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"body": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/notes'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"body":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/notes",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"body":"string"},
)Link a ticket to a tracker
Links a customer ticket to a tracker ticket, or unlinks it with a null trackerId.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| ticketId required | path | string | The ticket's id, or its number. |
Body
{
"trackerId?": "string | null"
}Responses
The ticket as saved
{
"id": "string",
"number": "integer",
"typeId": "string",
"category": "customer | back_office | tracker",
"stateId": "string",
"stateCategory": "submitted | in_progress | waiting_on_customer | resolved",
"title": "string",
"priority": "low | normal | high | urgent",
"assigneeUserId?": "string | null",
"distinctId?": "string | null",
"conversationId?": "string | null",
"trackerId?": "string | null",
"mergedInto?": "string | null",
"attributes": "object",
"createdByKind": "member | visitor | api",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string",
"resolvedAt?": "string | null"
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/tracker" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"trackerId":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/tracker', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"trackerId": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/tracker'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"trackerId":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/tracker",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"trackerId":"string"},
)Merge a ticket into another
Moves the ticket's notes and linked tickets into another ticket of the same category, and resolves it as merged.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| ticketId required | path | string | The ticket's id, or its number. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"into": "string"
}Responses
The ticket merged into
{
"id": "string",
"number": "integer",
"typeId": "string",
"category": "customer | back_office | tracker",
"stateId": "string",
"stateCategory": "submitted | in_progress | waiting_on_customer | resolved",
"title": "string",
"priority": "low | normal | high | urgent",
"assigneeUserId?": "string | null",
"distinctId?": "string | null",
"conversationId?": "string | null",
"trackerId?": "string | null",
"mergedInto?": "string | null",
"attributes": "object",
"createdByKind": "member | visitor | api",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string",
"resolvedAt?": "string | null"
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/merge" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"into":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/merge', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"into": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/merge'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"into":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/merge",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"into":"string"},
)List ticket types
A project's ticket types with their attributes, by name. Archived types only when `archived` is true.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| archived | query | string | true to include archived types. |
Responses
The ticket types
{
"types": [
{
"id": "string",
"name": "string",
"category": "customer | back_office | tracker",
"description?": "string | null",
"submittable": "boolean",
"attributes": [
{
"key": "string",
"label": "string",
"attributeType": "text | long_text | number | date | boolean | enum | multi_enum | url | phone | currency",
"options?": [
{
"value": "string",
"label": "string"
}
],
"customerFills?": "boolean",
"customerRequired?": "boolean",
"customerSees?": "boolean"
}
],
"archived": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
]
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/ticket-types" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ticket-types', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ticket-types'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/ticket-types",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a ticket type
A customer, back-office or tracker ticket type with its attributes.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"category": "customer | back_office | tracker",
"description?": "string | null",
"submittable?": "boolean",
"attributes?": [
{
"key": "string",
"label": "string",
"attributeType": "text | long_text | number | date | boolean | enum | multi_enum | url | phone | currency",
"options?": [
{
"value": "string",
"label": "string"
}
],
"customerFills?": "boolean",
"customerRequired?": "boolean",
"customerSees?": "boolean"
}
]
}Responses
The ticket type as saved
{
"id": "string",
"name": "string",
"category": "customer | back_office | tracker",
"description?": "string | null",
"submittable": "boolean",
"attributes": [
{
"key": "string",
"label": "string",
"attributeType": "text | long_text | number | date | boolean | enum | multi_enum | url | phone | currency",
"options?": [
{
"value": "string",
"label": "string"
}
],
"customerFills?": "boolean",
"customerRequired?": "boolean",
"customerSees?": "boolean"
}
],
"archived": "boolean",
"createdAt": "string",
"updatedAt": "string"
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/ticket-types" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","category":"string","description":"string","submittable":true,"attributes":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ticket-types', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"category": "string",
"description": "string",
"submittable": true,
"attributes": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ticket-types'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","category":"string","description":"string","submittable":true,"attributes":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/ticket-types",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","category":"string","description":"string","submittable":true,"attributes":[]},
)Change a ticket type
Replaces a ticket type's name, description, form and attributes. A type that holds tickets keeps its category.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| typeId required | path | string | The ticket type's id. |
Body
{
"name": "string",
"category": "customer | back_office | tracker",
"description?": "string | null",
"submittable?": "boolean",
"attributes?": [
{
"key": "string",
"label": "string",
"attributeType": "text | long_text | number | date | boolean | enum | multi_enum | url | phone | currency",
"options?": [
{
"value": "string",
"label": "string"
}
],
"customerFills?": "boolean",
"customerRequired?": "boolean",
"customerSees?": "boolean"
}
]
}Responses
The ticket type as saved
{
"id": "string",
"name": "string",
"category": "customer | back_office | tracker",
"description?": "string | null",
"submittable": "boolean",
"attributes": [
{
"key": "string",
"label": "string",
"attributeType": "text | long_text | number | date | boolean | enum | multi_enum | url | phone | currency",
"options?": [
{
"value": "string",
"label": "string"
}
],
"customerFills?": "boolean",
"customerRequired?": "boolean",
"customerSees?": "boolean"
}
],
"archived": "boolean",
"createdAt": "string",
"updatedAt": "string"
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/ticket-types/:typeId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","category":"string","description":"string","submittable":true,"attributes":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ticket-types/:typeId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"category": "string",
"description": "string",
"submittable": true,
"attributes": []
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ticket-types/:typeId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","category":"string","description":"string","submittable":true,"attributes":[]}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/ticket-types/:typeId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","category":"string","description":"string","submittable":true,"attributes":[]},
)Archive or restore a ticket type
An archived type takes no new tickets; its tickets stay.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| typeId required | path | string | The ticket type's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"archived": "boolean"
}Responses
The ticket type as saved
{
"id": "string",
"name": "string",
"category": "customer | back_office | tracker",
"description?": "string | null",
"submittable": "boolean",
"attributes": [
{
"key": "string",
"label": "string",
"attributeType": "text | long_text | number | date | boolean | enum | multi_enum | url | phone | currency",
"options?": [
{
"value": "string",
"label": "string"
}
],
"customerFills?": "boolean",
"customerRequired?": "boolean",
"customerSees?": "boolean"
}
],
"archived": "boolean",
"createdAt": "string",
"updatedAt": "string"
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/ticket-types/:typeId/archive" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"archived":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ticket-types/:typeId/archive', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"archived": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ticket-types/:typeId/archive'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"archived":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/ticket-types/:typeId/archive",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"archived":true},
)List ticket states
A project's ticket states in order, each with its customer label and category. A project starts with one per category.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The states
{
"states": [
{
"id": "string",
"name": "string",
"customerLabel": "string",
"category": "submitted | in_progress | waiting_on_customer | resolved",
"position": "integer",
"ticketCount": "integer"
}
]
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/ticket-states" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ticket-states', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ticket-states'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/ticket-states",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Set ticket states
Replaces the project's ticket states in order. Every category keeps at least one state, and a state that still holds tickets cannot be removed.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Body
{
"states": [
{
"id?": "string | null",
"name": "string",
"customerLabel": "string",
"category": "submitted | in_progress | waiting_on_customer | resolved"
}
]
}Responses
The states as saved
{
"states": [
{
"id": "string",
"name": "string",
"customerLabel": "string",
"category": "submitted | in_progress | waiting_on_customer | resolved",
"position": "integer",
"ticketCount": "integer"
}
]
}The request breaks a ticket rule
The caller may not do this
The project, ticket, type or state is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/ticket-states" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"states":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/ticket-states', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"states": []
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/ticket-states'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"states":[]}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/ticket-states",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"states":[]},
)List SLA policies
A project's service level policies with their targets in minutes.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The policies
{
"policies": [
{
"id": "string",
"name": "string",
"hours": "office | always",
"firstResponseMinutes?": "integer | null",
"nextResponseMinutes?": "integer | null",
"closeMinutes?": "integer | null",
"resolveMinutes?": "integer | null",
"updatedAt": "string"
}
]
}The request breaks an SLA rule
The caller may not do this
The project, policy or record is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/sla-policies" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/sla-policies', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/sla-policies'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/sla-policies",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create an SLA policy
A policy with first response, next response, time to close and time to resolve targets, counted in office hours or around the clock.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"hours": "office | always",
"firstResponseMinutes?": "integer | null",
"nextResponseMinutes?": "integer | null",
"closeMinutes?": "integer | null",
"resolveMinutes?": "integer | null"
}Responses
The policy as saved
{
"id": "string",
"name": "string",
"hours": "office | always",
"firstResponseMinutes?": "integer | null",
"nextResponseMinutes?": "integer | null",
"closeMinutes?": "integer | null",
"resolveMinutes?": "integer | null",
"updatedAt": "string"
}The request breaks an SLA rule
The caller may not do this
The project, policy or record is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/sla-policies" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","hours":"string","firstResponseMinutes":0,"nextResponseMinutes":0,"closeMinutes":0,"resolveMinutes":0}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/sla-policies', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"hours": "string",
"firstResponseMinutes": 0,
"nextResponseMinutes": 0,
"closeMinutes": 0,
"resolveMinutes": 0
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/sla-policies'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","hours":"string","firstResponseMinutes":0,"nextResponseMinutes":0,"closeMinutes":0,"resolveMinutes":0}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/sla-policies",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","hours":"string","firstResponseMinutes":0,"nextResponseMinutes":0,"closeMinutes":0,"resolveMinutes":0},
)Change an SLA policy
Replaces a policy's name, hours and targets. Clocks already running keep the targets they started with.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| policyId required | path | string | The SLA policy's id. |
Body
{
"name": "string",
"hours": "office | always",
"firstResponseMinutes?": "integer | null",
"nextResponseMinutes?": "integer | null",
"closeMinutes?": "integer | null",
"resolveMinutes?": "integer | null"
}Responses
The policy as saved
{
"id": "string",
"name": "string",
"hours": "office | always",
"firstResponseMinutes?": "integer | null",
"nextResponseMinutes?": "integer | null",
"closeMinutes?": "integer | null",
"resolveMinutes?": "integer | null",
"updatedAt": "string"
}The request breaks an SLA rule
The caller may not do this
The project, policy or record is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/sla-policies/:policyId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","hours":"string","firstResponseMinutes":0,"nextResponseMinutes":0,"closeMinutes":0,"resolveMinutes":0}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/sla-policies/:policyId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"hours": "string",
"firstResponseMinutes": 0,
"nextResponseMinutes": 0,
"closeMinutes": 0,
"resolveMinutes": 0
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/sla-policies/:policyId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","hours":"string","firstResponseMinutes":0,"nextResponseMinutes":0,"closeMinutes":0,"resolveMinutes":0}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/sla-policies/:policyId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","hours":"string","firstResponseMinutes":0,"nextResponseMinutes":0,"closeMinutes":0,"resolveMinutes":0},
)Delete an SLA policy
Deletes a policy and the rules that choose it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| policyId required | path | string | The SLA policy's id. |
Responses
Deleted
The request breaks an SLA rule
The caller may not do this
The project, policy or record is not there
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/sla-policies/:policyId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/sla-policies/:policyId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/sla-policies/:policyId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/sla-policies/:policyId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List SLA rules
The rules that choose a new conversation's or ticket's policy, in order, first match wins.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The rules
{
"rules": [
{
"policyId": "string",
"recordKind?": "RecordKind | null",
"ticketTypeIds?": [],
"priorities?": [],
"conditions?": [
{
"attribute": "string",
"op": "eq | neq | in | not_in | contains | gt | gte | lt | lte | is_set | is_not_set | in_cohort | not_in_cohort",
"value?": "unknown"
}
]
}
]
}The request breaks an SLA rule
The caller may not do this
The project, policy or record is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/sla-rules" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/sla-rules', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/sla-rules'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/sla-rules",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Set SLA rules
Replaces the rules in order. Each names a policy, and may narrow by record kind, ticket type, priority and person properties.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Body
{
"rules": [
{
"policyId": "string",
"recordKind?": "RecordKind | null",
"ticketTypeIds?": [],
"priorities?": [],
"conditions?": [
{
"attribute": "string",
"op": "eq | neq | in | not_in | contains | gt | gte | lt | lte | is_set | is_not_set | in_cohort | not_in_cohort",
"value?": "unknown"
}
]
}
]
}Responses
The rules as saved
{
"rules": [
{
"policyId": "string",
"recordKind?": "RecordKind | null",
"ticketTypeIds?": [],
"priorities?": [],
"conditions?": [
{
"attribute": "string",
"op": "eq | neq | in | not_in | contains | gt | gte | lt | lte | is_set | is_not_set | in_cohort | not_in_cohort",
"value?": "unknown"
}
]
}
]
}The request breaks an SLA rule
The caller may not do this
The project, policy or record is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/sla-rules" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"rules":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/sla-rules', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"rules": []
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/sla-rules'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"rules":[]}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/sla-rules",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"rules":[]},
)Read a record's SLA clocks
A conversation's or ticket's clocks: each target, the time spent against it, and when it was met or breached.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| recordKind required | query | string | conversation or ticket. |
| recordId required | query | string | The conversation's or ticket's id. |
Responses
The clocks
{
"clocks": [
{
"target": "string",
"targetSeconds": "integer",
"spentSeconds": "integer",
"startedAt": "string",
"metAt?": "string | null",
"breachedAt?": "string | null"
}
]
}The request breaks an SLA rule
The caller may not do this
The project, policy or record is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/sla-clocks" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/sla-clocks', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/sla-clocks'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/sla-clocks",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the ticket forms a visitor can submit
Answers the project's customer ticket types marked submittable, each with the fields the customer fills in.
Responses
The ticket forms
{
"forms": [
{
"typeId": "string",
"name": "string",
"description?": "string | null",
"fields": [
{
"key": "string",
"label": "string",
"attributeType": "text | long_text | number | date | boolean | enum | multi_enum | url | phone | currency",
"options": [
{
"value": "string",
"label": "string"
}
],
"required": "boolean"
}
]
}
]
}The ticket breaks a rule of its type
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key, or a visitor that did not verify
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many requests from this project or address
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/tickets/forms" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/tickets/forms', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/tickets/forms'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/tickets/forms",
headers={"Authorization": f"Bearer {project_key}"},
)Read a verified visitor's tickets
Answers the visitor's customer tickets, most recently changed first, with the customer label of their state and the attributes they may see. A visitor that does not verify answers an empty list.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| user_id | query | string | The signed-in visitor's id, sent with user_hash. |
| user_hash | query | string | HMAC-SHA256 of user_id under the project's signing secret, as the messenger's identify sends it. |
Responses
The visitor's tickets
{
"tickets": [
{
"number": "integer",
"title": "string",
"typeName": "string",
"stateLabel": "string",
"stateCategory": "submitted | in_progress | waiting_on_customer | resolved",
"attributes": "object",
"conversationId?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}
]
}The ticket breaks a rule of its type
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key, or a visitor that did not verify
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many requests from this project or address
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/tickets" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/tickets', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/tickets'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/tickets",
headers={"Authorization": f"Bearer {project_key}"},
)Submit a ticket
Opens a customer ticket of a submittable type for a verified visitor, checks the form against the type, and opens the conversation the ticket talks through, answering its token as a conversation open does.
Body
{
"typeId": "string",
"title": "string",
"attributes?": "object",
"distinctId": "string",
"userId": "string",
"userHash": "string"
}Responses
The ticket's number and its conversation
{
"number": "integer",
"conversation": {
"conversationId": "string",
"token": "string",
"expiresInSeconds": "integer"
}
}The ticket breaks a rule of its type
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key, or a visitor that did not verify
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many requests from this project or address
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://api.prodantix.com/v1/tickets" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"typeId":"string","title":"string","attributes":{},"distinctId":"string","userId":"string","userHash":"string"}'const response = await fetch('https://api.prodantix.com/v1/tickets', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"typeId": "string",
"title": "string",
"attributes": {},
"distinctId": "string",
"userId": "string",
"userHash": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/tickets'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"typeId":"string","title":"string","attributes":{},"distinctId":"string","userId":"string","userHash":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/tickets",
headers={"Authorization": f"Bearer {project_key}"},
json={"typeId":"string","title":"string","attributes":{},"distinctId":"string","userId":"string","userHash":"string"},
)Open a ticket's conversation
Answers a token for the conversation of one of a verified visitor's own customer tickets, so the messenger can show and continue it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| number required | path | integer | The ticket's number in its project. |
Body
{
"userId": "string",
"userHash": "string"
}Responses
The ticket's conversation and a token for it
{
"conversationId": "string",
"token": "string",
"expiresInSeconds": "integer"
}The ticket breaks a rule of its type
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key, or a visitor that did not verify
{
"statusCode": "integer",
"message": "string",
"error": "string"
}No ticket of the visitor's has that number, or it has no conversation
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many requests from this project or address
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://api.prodantix.com/v1/tickets/:number/conversation" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"userId":"string","userHash":"string"}'const response = await fetch('https://api.prodantix.com/v1/tickets/:number/conversation', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"userId": "string",
"userHash": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/tickets/:number/conversation'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"userId":"string","userHash":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/tickets/:number/conversation",
headers={"Authorization": f"Bearer {project_key}"},
json={"userId":"string","userHash":"string"},
)conversations
List conversations
The agent inbox, newest activity first. One view at a time: `distinctId` for one person's threads in every status, else `assignedToMe`, else `flagged`, else `handedOver`, else `heldAsSpam`, else `status`, else every thread. Every view but `heldAsSpam` leaves held threads out. `search` matches the person's id, name and email, the subject and the words of any turn. Page with the last row's `lastTurnAt` and `id`.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| distinctId | query | string | One person's threads, in every status. |
| status | query | string | open, snoozed or resolved. |
| assignedToMe | query | string | true for the caller's threads. |
| flagged | query | string | true for flagged threads. |
| handedOver | query | string | true for threads the assistant handed to the team. |
| heldAsSpam | query | string | true for threads held as spam. |
| search | query | string | Words to match. |
| cursorLastTurnAt | query | string | The last row's lastTurnAt. |
| cursorId | query | string | The last row's id. |
| limit | query | string | At most this many, up to 200. 50 when left out. |
Responses
The conversations
{
"conversations": [
{
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"assigneeUserId?": "string | null",
"assigneeMemberSub?": "string | null",
"snoozedUntil?": "string | null",
"unreadForAgent": "boolean",
"lastTurnAt": "string",
"createdAt": "string",
"flagged": "boolean",
"personName?": "string | null",
"personEmail?": "string | null",
"lastTurnBody?": "string | null",
"lastTurnAuthorKind?": "string | null",
"heldAsSpamAt?": "string | null",
"openHandover?": {
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
},
"priority": "low | normal | high | urgent",
"attributes": "object",
"visitorLanguage?": "string | null",
"channel": "string"
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/conversations",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a conversation
One thread, oldest turn first: its latest `limit` turns (100 by default, at most 500), or the ones before the turn `before` names, with its handovers.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| limit | query | string | How many turns, up to 500. |
| before | query | string | A turn's id, to read the turns before it. |
Responses
The thread
{
"conversation": {
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"assigneeUserId?": "string | null",
"assigneeMemberSub?": "string | null",
"snoozedUntil?": "string | null",
"unreadForAgent": "boolean",
"lastTurnAt": "string",
"createdAt": "string",
"flagged": "boolean",
"personName?": "string | null",
"personEmail?": "string | null",
"lastTurnBody?": "string | null",
"lastTurnAuthorKind?": "string | null",
"heldAsSpamAt?": "string | null",
"openHandover?": {
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
},
"priority": "low | normal | high | urgent",
"attributes": "object",
"visitorLanguage?": "string | null",
"channel": "string"
},
"turns": [
{
"id": "string",
"authorKind": "string",
"authorId?": "string | null",
"body": "string",
"createdAt": "string",
"pageContext?": {
"host": "string",
"path": "string",
"title": "string"
},
"authorName?": "string | null",
"authorAvatarUrl?": "string | null",
"attachments": [
{
"id": "string",
"name": "string",
"contentType": "string",
"bytes": "integer",
"url": "string",
"removed": "boolean"
}
],
"original?": {
"body": "string",
"language": "string",
"translatedLanguage": "string"
}
}
],
"hasEarlierTurns": "boolean",
"handovers": [
{
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Reply to a conversation
Sends the caller's reply at once and clears their draft. The person sees it in the messenger straight away.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"body": "string",
"original?": {
"body": "string",
"language": "string",
"translatedLanguage": "string"
}
}Responses
The reply as sent
{
"id": "string",
"authorKind": "string",
"authorId?": "string | null",
"body": "string",
"createdAt": "string",
"pageContext?": {
"host": "string",
"path": "string",
"title": "string"
},
"authorName?": "string | null",
"authorAvatarUrl?": "string | null",
"attachments": [
{
"id": "string",
"name": "string",
"contentType": "string",
"bytes": "integer",
"url": "string",
"removed": "boolean"
}
],
"original?": {
"body": "string",
"language": "string",
"translatedLanguage": "string"
}
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/replies" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"body":"string","original":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/replies', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"body": "string",
"original": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/replies'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"body":"string","original":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/replies",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"body":"string","original":"string"},
)Hold a reply for the undo window
Holds the caller's reply for their undo window, then sends it. Refused while the window is off.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"body": "string",
"original?": {
"body": "string",
"language": "string",
"translatedLanguage": "string"
}
}Responses
The held reply
{
"id": "string",
"conversationId": "string",
"sendAt": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/held-replies" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"body":"string","original":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/held-replies', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"body": "string",
"original": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/held-replies'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"body":"string","original":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/held-replies",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"body":"string","original":"string"},
)Take a held reply back
Takes the caller's held reply back before it is sent and answers its text, or a null body once it has gone.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| replyId required | path | string | The held reply's id. |
Responses
The reply's text
{
"body?": "string | null"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/held-replies/:replyId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/held-replies/:replyId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/held-replies/:replyId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/held-replies/:replyId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Assign a conversation
Assigns the thread to the caller, or clears the assignment.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
Body
{
"toMe": "boolean",
"memberSub?": "string | null"
}Responses
The conversation
{
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"assigneeUserId?": "string | null",
"assigneeMemberSub?": "string | null",
"snoozedUntil?": "string | null",
"unreadForAgent": "boolean",
"lastTurnAt": "string",
"createdAt": "string",
"flagged": "boolean",
"personName?": "string | null",
"personEmail?": "string | null",
"lastTurnBody?": "string | null",
"lastTurnAuthorKind?": "string | null",
"heldAsSpamAt?": "string | null",
"openHandover?": {
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
},
"priority": "low | normal | high | urgent",
"attributes": "object",
"visitorLanguage?": "string | null",
"channel": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/assignee" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"toMe":true,"memberSub":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/assignee', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"toMe": true,
"memberSub": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/assignee'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"toMe":true,"memberSub":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/assignee",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"toMe":true,"memberSub":"string"},
)Open, snooze or resolve a conversation
Moves the thread between open, snoozed and resolved. Snoozing needs `snoozedUntil`; the other statuses clear it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
Body
{
"status": "string",
"snoozedUntil?": "string | null"
}Responses
The conversation
{
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"assigneeUserId?": "string | null",
"assigneeMemberSub?": "string | null",
"snoozedUntil?": "string | null",
"unreadForAgent": "boolean",
"lastTurnAt": "string",
"createdAt": "string",
"flagged": "boolean",
"personName?": "string | null",
"personEmail?": "string | null",
"lastTurnBody?": "string | null",
"lastTurnAuthorKind?": "string | null",
"heldAsSpamAt?": "string | null",
"openHandover?": {
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
},
"priority": "low | normal | high | urgent",
"attributes": "object",
"visitorLanguage?": "string | null",
"channel": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/status" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"status":"string","snoozedUntil":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/status', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"status": "string",
"snoozedUntil": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/status'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"status":"string","snoozedUntil":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/status",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"status":"string","snoozedUntil":"string"},
)Flag a conversation
Sets or clears the flag on a thread, a mark for finding it again.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
Body
{
"flagged": "boolean"
}Responses
The conversation
{
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"assigneeUserId?": "string | null",
"assigneeMemberSub?": "string | null",
"snoozedUntil?": "string | null",
"unreadForAgent": "boolean",
"lastTurnAt": "string",
"createdAt": "string",
"flagged": "boolean",
"personName?": "string | null",
"personEmail?": "string | null",
"lastTurnBody?": "string | null",
"lastTurnAuthorKind?": "string | null",
"heldAsSpamAt?": "string | null",
"openHandover?": {
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
},
"priority": "low | normal | high | urgent",
"attributes": "object",
"visitorLanguage?": "string | null",
"channel": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/flag" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"flagged":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/flag', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"flagged": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/flag'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"flagged":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/flag",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"flagged":true},
)Release a conversation held as spam
Returns a thread held as spam to the inbox.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The conversation
{
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"assigneeUserId?": "string | null",
"assigneeMemberSub?": "string | null",
"snoozedUntil?": "string | null",
"unreadForAgent": "boolean",
"lastTurnAt": "string",
"createdAt": "string",
"flagged": "boolean",
"personName?": "string | null",
"personEmail?": "string | null",
"lastTurnBody?": "string | null",
"lastTurnAuthorKind?": "string | null",
"heldAsSpamAt?": "string | null",
"openHandover?": {
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
},
"priority": "low | normal | high | urgent",
"attributes": "object",
"visitorLanguage?": "string | null",
"channel": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/not-spam" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/not-spam', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/not-spam'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/not-spam",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Set a conversation's priority
Sets the thread's priority: low, normal, high or urgent.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
Body
{
"priority": "low | normal | high | urgent"
}Responses
The conversation
{
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"assigneeUserId?": "string | null",
"assigneeMemberSub?": "string | null",
"snoozedUntil?": "string | null",
"unreadForAgent": "boolean",
"lastTurnAt": "string",
"createdAt": "string",
"flagged": "boolean",
"personName?": "string | null",
"personEmail?": "string | null",
"lastTurnBody?": "string | null",
"lastTurnAuthorKind?": "string | null",
"heldAsSpamAt?": "string | null",
"openHandover?": {
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
},
"priority": "low | normal | high | urgent",
"attributes": "object",
"visitorLanguage?": "string | null",
"channel": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/priority" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"priority":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/priority', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"priority": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/priority'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"priority":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/priority",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"priority":"string"},
)Set a conversation's attributes
Sets values of the project's conversation attributes on the thread; a null value clears one.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"values": "object"
}Responses
The conversation
{
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"assigneeUserId?": "string | null",
"assigneeMemberSub?": "string | null",
"snoozedUntil?": "string | null",
"unreadForAgent": "boolean",
"lastTurnAt": "string",
"createdAt": "string",
"flagged": "boolean",
"personName?": "string | null",
"personEmail?": "string | null",
"lastTurnBody?": "string | null",
"lastTurnAuthorKind?": "string | null",
"heldAsSpamAt?": "string | null",
"openHandover?": {
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
},
"priority": "low | normal | high | urgent",
"attributes": "object",
"visitorLanguage?": "string | null",
"channel": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PATCH "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/attributes" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"values":{}}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/attributes', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"values": {}
}),
});
const data = await response.json();final response = await http.patch(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/attributes'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"values":{}}),
);response = requests.patch(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/attributes",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"values":{}},
)Read the caller's draft
The caller's unsent reply on the thread, kept as they typed it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
Responses
The draft
{
"body?": "string | null"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/draft" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/draft', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/draft'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/draft",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Keep the caller's draft
Keeps the caller's unsent reply; an empty or null body clears it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
Body
{
"body?": "string | null"
}Responses
The draft as kept
{
"body?": "string | null"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/draft" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"body":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/draft', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"body": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/draft'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"body":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/draft",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"body":"string"},
)Mark a conversation read
Clears the thread's unread mark for the team.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The conversation
{
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"assigneeUserId?": "string | null",
"assigneeMemberSub?": "string | null",
"snoozedUntil?": "string | null",
"unreadForAgent": "boolean",
"lastTurnAt": "string",
"createdAt": "string",
"flagged": "boolean",
"personName?": "string | null",
"personEmail?": "string | null",
"lastTurnBody?": "string | null",
"lastTurnAuthorKind?": "string | null",
"heldAsSpamAt?": "string | null",
"openHandover?": {
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
},
"priority": "low | normal | high | urgent",
"attributes": "object",
"visitorLanguage?": "string | null",
"channel": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/read" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/read', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/read'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/read",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Merge a conversation into another
Moves the thread's turns, files, ticket links and held replies into another conversation of the same person, verified the same way, and resolves it. The person's messenger follows.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"into": "string"
}Responses
The conversation merged into
{
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"assigneeUserId?": "string | null",
"assigneeMemberSub?": "string | null",
"snoozedUntil?": "string | null",
"unreadForAgent": "boolean",
"lastTurnAt": "string",
"createdAt": "string",
"flagged": "boolean",
"personName?": "string | null",
"personEmail?": "string | null",
"lastTurnBody?": "string | null",
"lastTurnAuthorKind?": "string | null",
"heldAsSpamAt?": "string | null",
"openHandover?": {
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
},
"priority": "low | normal | high | urgent",
"attributes": "object",
"visitorLanguage?": "string | null",
"channel": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/merge" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"into":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/merge', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"into": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/merge'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"into":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/merge",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"into":"string"},
)List people who may be the same person
Other people of the project who share this thread's person's email, at most ten.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
Responses
Their distinct ids
{
"distinctIds": [],
"people": [
{
"distinctId": "string",
"name?": "string | null",
"email": "string",
"matchedOn": []
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/duplicate-people" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/duplicate-people', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/duplicate-people'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/duplicate-people",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Mark a person not the same person
Records that this thread's person and the person named are not the same, so the pair is never offered again.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| distinctId required | path | string | The other person's distinct id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The pair is dismissed
The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/duplicate-people/:distinctId/dismissal" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/duplicate-people/:distinctId/dismissal', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/duplicate-people/:distinctId/dismissal'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/duplicate-people/:distinctId/dismissal",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Summarise a conversation
A few sentences on what the person needs, what was tried and what is open. Uses the company's AI add-on and needs the permission to ask AI as well as to read conversations.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The summary
{
"text": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/summary" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/summary', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/summary'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/summary",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Translate a turn or a reply
Translates text from the thread, or a reply before it is sent, into the language named. Nothing is written. Uses the company's AI add-on.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"text": "string",
"language": "string",
"turnId?": "string | null"
}Responses
The translation
{
"text": "string",
"sourceLanguage?": "string | null"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/translation" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"text":"string","language":"string","turnId":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/translation', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"text": "string",
"language": "string",
"turnId": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/translation'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"text":"string","language":"string","turnId":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/translation",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"text":"string","language":"string","turnId":"string"},
)Draft a reply with AI
Drafts a reply for the caller to review from the thread and the person's own properties. Nothing is sent. Uses the company's AI add-on.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The draft
{
"text": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/ai-draft" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/ai-draft', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/ai-draft'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/ai-draft",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Preview a macro on a conversation
The macro's reply as it would read on this thread, naming every placeholder with no value in `missing` and leaving it in the text.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| macroId required | path | string | The macro's id. |
Responses
The preview
{
"body": "string",
"missing": []
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/macros/:macroId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/macros/:macroId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/macros/:macroId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/macros/:macroId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Apply a macro to a conversation
Runs the macro's actions on the thread: its status, priority, assignee, flag and attributes. Its reply is sent the way any reply is.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| macroId required | path | string | The macro's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The conversation
{
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"assigneeUserId?": "string | null",
"assigneeMemberSub?": "string | null",
"snoozedUntil?": "string | null",
"unreadForAgent": "boolean",
"lastTurnAt": "string",
"createdAt": "string",
"flagged": "boolean",
"personName?": "string | null",
"personEmail?": "string | null",
"lastTurnBody?": "string | null",
"lastTurnAuthorKind?": "string | null",
"heldAsSpamAt?": "string | null",
"openHandover?": {
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
},
"priority": "low | normal | high | urgent",
"attributes": "object",
"visitorLanguage?": "string | null",
"channel": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/macros/:macroId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/macros/:macroId', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/macros/:macroId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/macros/:macroId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Count the inbox
Open, unread, snoozed, resolved, the caller's own, flagged, handed over and held as spam, in one read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The counts
{
"open": "integer",
"unread": "integer",
"snoozed": "integer",
"resolved": "integer",
"mine": "integer",
"flagged": "integer",
"handedOver": "integer",
"spam": "integer"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversation-counts" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversation-counts', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversation-counts'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/conversation-counts",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List conversation attributes
The attributes the project's conversations carry.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The attributes
{
"attributes": [
{
"key": "string",
"label": "string",
"attributeType": "text | long_text | number | date | boolean | enum | multi_enum | url | phone | currency",
"options?": [
{
"value": "string",
"label": "string"
}
],
"customerFills?": "boolean",
"customerRequired?": "boolean",
"customerSees?": "boolean"
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversation-attributes" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversation-attributes', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversation-attributes'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/conversation-attributes",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Set conversation attributes
Replaces the attributes the project's conversations carry.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Body
{
"attributes": [
{
"key": "string",
"label": "string",
"attributeType": "text | long_text | number | date | boolean | enum | multi_enum | url | phone | currency",
"options?": [
{
"value": "string",
"label": "string"
}
],
"customerFills?": "boolean",
"customerRequired?": "boolean",
"customerSees?": "boolean"
}
]
}Responses
The attributes as saved
{
"attributes": [
{
"key": "string",
"label": "string",
"attributeType": "text | long_text | number | date | boolean | enum | multi_enum | url | phone | currency",
"options?": [
{
"value": "string",
"label": "string"
}
],
"customerFills?": "boolean",
"customerRequired?": "boolean",
"customerSees?": "boolean"
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/conversation-attributes" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"attributes":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversation-attributes', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"attributes": []
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversation-attributes'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"attributes":[]}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/conversation-attributes",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"attributes":[]},
)List the Slack inbox channels
The Slack channels whose messages land in the project's inbox as conversations.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The channels
{
"channels": [
{
"connectionId": "string",
"teamId": "string",
"channelId": "string",
"createdAt": "string"
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Map a Slack channel to the inbox
Maps a channel of a workspace the company installed the Slack app in to the project's inbox: each top-level message opens a conversation, its thread joins it, and replies post into the thread. The app must be able to see the channel, and a channel that feeds another company's inbox is refused. A channel mapped to another of the company's projects moves here. Needs the permission to manage the messenger.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Body
{
"connectionId": "string",
"channelId": "string"
}Responses
The channels
{
"channels": [
{
"connectionId": "string",
"teamId": "string",
"channelId": "string",
"createdAt": "string"
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"connectionId":"string","channelId":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"connectionId": "string",
"channelId": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"connectionId":"string","channelId":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"connectionId":"string","channelId":"string"},
)Unmap a Slack channel
Stops a Slack channel's messages landing in the project's inbox; its conversations stay. Needs the permission to manage the messenger.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| connectionId required | path | string | The Slack connection's id. |
| channelId required | path | string | The Slack channel's id. |
Responses
The channels left
{
"channels": [
{
"connectionId": "string",
"teamId": "string",
"channelId": "string",
"createdAt": "string"
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels/:connectionId/:channelId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels/:connectionId/:channelId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels/:connectionId/:channelId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels/:connectionId/:channelId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List WhatsApp templates
The company's WhatsApp-approved templates in its own Twilio account, with their text and variable keys. A reply more than 24 hours after the customer's last message must be one of them. Needs the SMS channel on the plan.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The templates
{
"templates": [
{
"sid": "string",
"name": "string",
"language": "string",
"body": "string",
"variables": []
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/whatsapp-templates" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/whatsapp-templates', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/whatsapp-templates'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/whatsapp-templates",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Send a WhatsApp template
Sends an approved template on a WhatsApp conversation with a value for each of its variables, inside or outside the 24-hour window, and writes the filled text as the member's turn. Refused for a number that opted out. Needs the SMS channel on the plan.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"contentSid": "string",
"variables?": "object"
}Responses
The turn
{
"id": "string",
"authorKind": "string",
"authorId?": "string | null",
"body": "string",
"createdAt": "string",
"pageContext?": {
"host": "string",
"path": "string",
"title": "string"
},
"authorName?": "string | null",
"authorAvatarUrl?": "string | null",
"attachments": [
{
"id": "string",
"name": "string",
"contentType": "string",
"bytes": "integer",
"url": "string",
"removed": "boolean"
}
],
"original?": {
"body": "string",
"language": "string",
"translatedLanguage": "string"
}
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/whatsapp-template" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"contentSid":"string","variables":{}}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/whatsapp-template', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"contentSid": "string",
"variables": {}
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/whatsapp-template'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"contentSid":"string","variables":{}}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/whatsapp-template",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"contentSid":"string","variables":{}},
)Make the support reports
Makes the project's support board the first time, with its reports over the inbox's events: conversations started by channel, first reply time (median and 90th percentile), time to close, reopened conversations, replies by member and SLA targets. Answers the board's id; later calls answer the same board. The plan needs room for one board and every report.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The support board
{
"dashboardId": "string"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/support-reports" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/support-reports', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/support-reports'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/support-reports",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List an email conversation's participants
The other people on an email conversation: everyone the customer wrote to or copied, kept in Cc on every reply.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
Responses
The participants
{
"participants": []
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/participants" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/participants', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/participants'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/participants",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Remove a participant
Takes one person off an email conversation's replies. Needs the permission to send messages.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The conversation's id. |
| address required | path | string | The participant's email address. |
Responses
The participants left
{
"participants": []
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/participants/:address" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/participants/:address', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/participants/:address'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/participants/:address",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read your email signature
The signature your email replies in this company end with; null when you have none.
Responses
The signature
{
"signature?": "string | null"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/email-signature" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/email-signature', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/email-signature'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/email-signature",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Set your email signature
Sets the signature your email replies in this company end with, at most 1000 characters. An empty signature removes it.
Body
{
"signature?": "string | null"
}Responses
The signature
{
"signature?": "string | null"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/email-signature" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"signature":"string"}'const response = await fetch('https://api.prodantix.com/v1/email-signature', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"signature": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/email-signature'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"signature":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/email-signature",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"signature":"string"},
)Read the reply-from address
The address the project's email replies come from, on a sending domain the company has verified; null while replies come from the support address.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The address
{
"address?": "string | null"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/support-reply-from" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/support-reply-from', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/support-reply-from'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/support-reply-from",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Set the reply-from address
Sets the address the project's email replies come from. It must be on a sending domain the company has verified; an empty address goes back to the support address. Needs the permission to manage the messenger.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Body
{
"address?": "string | null"
}Responses
The address
{
"address?": "string | null"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/support-reply-from" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"address":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/support-reply-from', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"address": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/support-reply-from'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"address":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/support-reply-from",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"address":"string"},
)Read the support address
The address the company forwards its support email to, claimed from the project's slug the first time it is read. Null when this deploy receives no email.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The address
{
"address?": "string | null",
"lastReceivedAt?": "string | null"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/support-address" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/support-address', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/support-address'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/support-address",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the assignment setup
How new conversations are assigned, and each member's limit and away mark.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The setup
{
"method": "manual | round_robin | balanced",
"members": [
{
"memberSub": "string",
"away": "boolean",
"assignmentLimit?": "integer | null"
}
],
"loads": [
{
"userId": "string",
"memberSub?": "string | null",
"open": "integer",
"awaitingReply": "integer",
"away": "boolean"
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/inbox-assignment" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/inbox-assignment', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/inbox-assignment'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/inbox-assignment",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Choose how conversations are assigned
Manual, round robin (Growth and up) or balanced (Scale and up).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Body
{
"method": "manual | round_robin | balanced"
}Responses
The method as saved
{
"method": "manual | round_robin | balanced"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/inbox-assignment" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"method":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/inbox-assignment', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"method": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/inbox-assignment'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"method":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/inbox-assignment",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"method":"string"},
)Limit a member's open conversations
Caps how many open conversations assignment hands one member; null lifts the cap. Scale and up.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| memberSub required | path | string | The member's identity. |
Body
{
"limit?": "integer | null"
}Responses
The member's status
{
"memberSub": "string",
"away": "boolean",
"assignmentLimit?": "integer | null"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/inbox-assignment/members/:memberSub" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"limit":0}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/inbox-assignment/members/:memberSub', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"limit": 0
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/inbox-assignment/members/:memberSub'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"limit":0}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/inbox-assignment/members/:memberSub",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"limit":0},
)Mark the caller away or back
Away takes no new assignments; with `returnOpen` the caller's open conversations go back to be assigned.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Body
{
"away": "boolean",
"returnOpen?": "boolean"
}Responses
The caller's status
{
"memberSub": "string",
"away": "boolean",
"assignmentLimit?": "integer | null"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/inbox-assignment/me" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"away":true,"returnOpen":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/inbox-assignment/me', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"away": true,
"returnOpen": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/inbox-assignment/me'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"away":true,"returnOpen":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/inbox-assignment/me",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"away":true,"returnOpen":true},
)Read the live inbox dashboard
Open and unassigned conversations, those awaiting a reply and the longest wait, the median first response over the last day, and each member's load. Scale and up.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The dashboard
{
"open": "integer",
"unassigned": "integer",
"awaitingReply": "integer",
"longestWaitSeconds?": "integer | null",
"medianFirstResponseSeconds?": "integer | null",
"members": [
{
"userId": "string",
"memberSub?": "string | null",
"open": "integer",
"awaitingReply": "integer",
"away": "boolean"
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/inbox-dashboard" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/inbox-dashboard', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/inbox-dashboard'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/inbox-dashboard",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List saved views
The caller's own views and the shared ones, in the caller's order.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The views
{
"views": [
{
"id": "string",
"name": "string",
"shared": "boolean",
"conditions": {
"status?": "string | null",
"assignee?": "Assignee | null",
"assigneeMemberSub?": "string | null",
"priorityAtLeast?": "Priority | null",
"flagged?": "boolean",
"unread?": "boolean",
"handedOver?": "boolean",
"attributes?": [
{
"key": "string",
"value": "string"
}
],
"channel?": "string | null"
},
"sort": "newest | oldest_waiting | priority"
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/inbox-views" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/inbox-views', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/inbox-views'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/inbox-views",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Save a view
Saves a view of the inbox. A shared view needs the permission to manage the messenger.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"shared": "boolean",
"conditions": {
"status?": "string | null",
"assignee?": "Assignee | null",
"assigneeMemberSub?": "string | null",
"priorityAtLeast?": "Priority | null",
"flagged?": "boolean",
"unread?": "boolean",
"handedOver?": "boolean",
"attributes?": [
{
"key": "string",
"value": "string"
}
],
"channel?": "string | null"
},
"sort?": "newest | oldest_waiting | priority"
}Responses
The view as saved
{
"id": "string",
"name": "string",
"shared": "boolean",
"conditions": {
"status?": "string | null",
"assignee?": "Assignee | null",
"assigneeMemberSub?": "string | null",
"priorityAtLeast?": "Priority | null",
"flagged?": "boolean",
"unread?": "boolean",
"handedOver?": "boolean",
"attributes?": [
{
"key": "string",
"value": "string"
}
],
"channel?": "string | null"
},
"sort": "newest | oldest_waiting | priority"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/inbox-views" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","shared":true,"conditions":"string","sort":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/inbox-views', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"shared": true,
"conditions": "string",
"sort": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/inbox-views'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","shared":true,"conditions":"string","sort":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/inbox-views",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","shared":true,"conditions":"string","sort":"string"},
)Count each saved view
How many conversations each of the caller's saved views selects now.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The counts
{
"counts": [
{
"viewId": "string",
"count": "integer"
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/inbox-view-counts" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/inbox-view-counts', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/inbox-view-counts'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/inbox-view-counts",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Change a saved view
Replaces a view's name, conditions and order.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| viewId required | path | string | The view's id. |
Body
{
"name": "string",
"shared": "boolean",
"conditions": {
"status?": "string | null",
"assignee?": "Assignee | null",
"assigneeMemberSub?": "string | null",
"priorityAtLeast?": "Priority | null",
"flagged?": "boolean",
"unread?": "boolean",
"handedOver?": "boolean",
"attributes?": [
{
"key": "string",
"value": "string"
}
],
"channel?": "string | null"
},
"sort?": "newest | oldest_waiting | priority"
}Responses
The view as saved
{
"id": "string",
"name": "string",
"shared": "boolean",
"conditions": {
"status?": "string | null",
"assignee?": "Assignee | null",
"assigneeMemberSub?": "string | null",
"priorityAtLeast?": "Priority | null",
"flagged?": "boolean",
"unread?": "boolean",
"handedOver?": "boolean",
"attributes?": [
{
"key": "string",
"value": "string"
}
],
"channel?": "string | null"
},
"sort": "newest | oldest_waiting | priority"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","shared":true,"conditions":"string","sort":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"shared": true,
"conditions": "string",
"sort": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","shared":true,"conditions":"string","sort":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","shared":true,"conditions":"string","sort":"string"},
)Delete a saved view
Deletes a view.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| viewId required | path | string | The view's id. |
Responses
The view is gone
The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List a view's conversations
The conversations a saved view selects, in the view's order. Page with `cursor`, passing back the `nextCursor` of the page before.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| viewId required | path | string | The view's id. |
| search | query | string | Words to match. |
| cursor | query | string | The nextCursor of the page before. |
| limit | query | string | At most this many, up to 200. 50 when left out. |
Responses
The page
{
"conversations": [
{
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"assigneeUserId?": "string | null",
"assigneeMemberSub?": "string | null",
"snoozedUntil?": "string | null",
"unreadForAgent": "boolean",
"lastTurnAt": "string",
"createdAt": "string",
"flagged": "boolean",
"personName?": "string | null",
"personEmail?": "string | null",
"lastTurnBody?": "string | null",
"lastTurnAuthorKind?": "string | null",
"heldAsSpamAt?": "string | null",
"openHandover?": {
"reason": "string",
"openedAt": "string",
"clearedAt?": "string | null",
"turnId?": "string | null"
},
"priority": "low | normal | high | urgent",
"attributes": "object",
"visitorLanguage?": "string | null",
"channel": "string"
}
],
"nextCursor?": "string | null"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId/conversations" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId/conversations', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId/conversations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId/conversations",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Order the caller's views
Sets the order the caller sees their views in. Views left out keep their place after the ones named.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Body
{
"ids": []
}Responses
The views in order
{
"views": [
{
"id": "string",
"name": "string",
"shared": "boolean",
"conditions": {
"status?": "string | null",
"assignee?": "Assignee | null",
"assigneeMemberSub?": "string | null",
"priorityAtLeast?": "Priority | null",
"flagged?": "boolean",
"unread?": "boolean",
"handedOver?": "boolean",
"attributes?": [
{
"key": "string",
"value": "string"
}
],
"channel?": "string | null"
},
"sort": "newest | oldest_waiting | priority"
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/inbox-view-order" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"ids":[]}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/inbox-view-order', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"ids": []
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/inbox-view-order'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"ids":[]}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/inbox-view-order",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"ids":[]},
)List macros
The caller's own macros and the shared ones.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The macros
{
"macros": [
{
"id": "string",
"name": "string",
"shared": "boolean",
"body": "string",
"actions": {
"status?": "string | null",
"priority?": "Priority | null",
"assign?": "Assign | null",
"assigneeMemberSub?": "string | null",
"flagged?": "boolean | null",
"attributes?": "object | null"
}
}
]
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/macros" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/macros', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/macros'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/macros",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Save a macro
A saved reply with placeholders, and actions. A shared macro, or one that assigns to a named member, needs the permission to manage the messenger.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"shared": "boolean",
"body?": "string",
"actions?": {
"status?": "string | null",
"priority?": "Priority | null",
"assign?": "Assign | null",
"assigneeMemberSub?": "string | null",
"flagged?": "boolean | null",
"attributes?": "object | null"
}
}Responses
The macro as saved
{
"id": "string",
"name": "string",
"shared": "boolean",
"body": "string",
"actions": {
"status?": "string | null",
"priority?": "Priority | null",
"assign?": "Assign | null",
"assigneeMemberSub?": "string | null",
"flagged?": "boolean | null",
"attributes?": "object | null"
}
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/macros" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","shared":true,"body":"string","actions":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/macros', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"shared": true,
"body": "string",
"actions": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/macros'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","shared":true,"body":"string","actions":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/macros",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","shared":true,"body":"string","actions":"string"},
)Change a macro
Replaces a macro's name, reply and actions.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| macroId required | path | string | The macro's id. |
Body
{
"name": "string",
"shared": "boolean",
"body?": "string",
"actions?": {
"status?": "string | null",
"priority?": "Priority | null",
"assign?": "Assign | null",
"assigneeMemberSub?": "string | null",
"flagged?": "boolean | null",
"attributes?": "object | null"
}
}Responses
The macro as saved
{
"id": "string",
"name": "string",
"shared": "boolean",
"body": "string",
"actions": {
"status?": "string | null",
"priority?": "Priority | null",
"assign?": "Assign | null",
"assigneeMemberSub?": "string | null",
"flagged?": "boolean | null",
"attributes?": "object | null"
}
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/macros/:macroId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","shared":true,"body":"string","actions":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/macros/:macroId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"shared": true,
"body": "string",
"actions": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/macros/:macroId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","shared":true,"body":"string","actions":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/macros/:macroId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","shared":true,"body":"string","actions":"string"},
)Delete a macro
Deletes a macro.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| macroId required | path | string | The macro's id. |
Responses
The macro is gone
The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/macros/:macroId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/macros/:macroId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/macros/:macroId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/macros/:macroId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the caller's undo window
How long the caller's held replies wait before they are sent: 0, 5, 10, 20 or 30 seconds.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Responses
The window
{
"seconds": "integer"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/reply-undo-seconds" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/reply-undo-seconds', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/reply-undo-seconds'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/reply-undo-seconds",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Set the caller's undo window
0 turns it off; otherwise 5, 10, 20 or 30 seconds.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
Body
{
"seconds": "integer"
}Responses
The window as saved
{
"seconds": "integer"
}The request breaks an inbox rule
The company's plan does not include this
The caller may not do this
The project, conversation, view, macro or held reply is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/reply-undo-seconds" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"seconds":0}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/reply-undo-seconds', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"seconds": 0
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/reply-undo-seconds'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"seconds":0}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/reply-undo-seconds",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"seconds":0},
)List side conversations
The side conversations beside one customer conversation, oldest first. Members only: the customer never sees them.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The customer conversation's id. |
Responses
The side conversations
[
{
"id": "string",
"conversationId": "string",
"subject": "string",
"status": "string",
"startedBy": "string",
"createdAt": "string",
"participants": []
}
]The request breaks a side conversation rule
The company has not added side conversations
The caller may not do this
The project, conversation or side conversation is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/side-conversations" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/side-conversations', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/side-conversations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/side-conversations",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Start a side conversation
Starts an email thread with 1 to 10 people outside the customer's conversation and sends its first message to them. Replies come back into it. Needs the permission to send messages.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| conversationId required | path | string | The customer conversation's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"subject": "string",
"to": [],
"body": "string"
}Responses
The side conversation and its first message
{
"sideConversation": {
"id": "string",
"conversationId": "string",
"subject": "string",
"status": "string",
"startedBy": "string",
"createdAt": "string",
"participants": []
},
"messages": [
{
"id": "string",
"direction": "string",
"memberSub?": "string | null",
"fromAddress": "string",
"body": "string",
"isProven": "boolean",
"sendFailedAt?": "string | null",
"createdAt": "string"
}
]
}The request breaks a side conversation rule
The company has not added side conversations
The caller may not do this
The project, conversation or side conversation is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/side-conversations" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"subject":"string","to":[],"body":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/side-conversations', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"subject": "string",
"to": [],
"body": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/side-conversations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"subject":"string","to":[],"body":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/side-conversations",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"subject":"string","to":[],"body":"string"},
)Read a side conversation
One side conversation with every message on it, oldest first.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| sideConversationId required | path | string | The side conversation's id. |
Responses
The side conversation and its messages
{
"sideConversation": {
"id": "string",
"conversationId": "string",
"subject": "string",
"status": "string",
"startedBy": "string",
"createdAt": "string",
"participants": []
},
"messages": [
{
"id": "string",
"direction": "string",
"memberSub?": "string | null",
"fromAddress": "string",
"body": "string",
"isProven": "boolean",
"sendFailedAt?": "string | null",
"createdAt": "string"
}
]
}The request breaks a side conversation rule
The company has not added side conversations
The caller may not do this
The project, conversation or side conversation is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Write on a side conversation
Sends a message to everyone on the side conversation. A message the email provider refuses is kept marked failed. Needs the permission to send messages.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| sideConversationId required | path | string | The side conversation's id. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"body": "string"
}Responses
The side conversation and its messages
{
"sideConversation": {
"id": "string",
"conversationId": "string",
"subject": "string",
"status": "string",
"startedBy": "string",
"createdAt": "string",
"participants": []
},
"messages": [
{
"id": "string",
"direction": "string",
"memberSub?": "string | null",
"fromAddress": "string",
"body": "string",
"isProven": "boolean",
"sendFailedAt?": "string | null",
"createdAt": "string"
}
]
}The request breaks a side conversation rule
The company has not added side conversations
The caller may not do this
The project, conversation or side conversation is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId/messages" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"body":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId/messages', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"body": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId/messages'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"body":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId/messages",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"body":"string"},
)Close or reopen a side conversation
Sets a side conversation `open` or `closed`. A reply to a closed one reopens it. The customer's conversation keeps its own status.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project's id. |
| sideConversationId required | path | string | The side conversation's id. |
Body
{
"status": "string"
}Responses
The side conversation
{
"id": "string",
"conversationId": "string",
"subject": "string",
"status": "string",
"startedBy": "string",
"createdAt": "string",
"participants": []
}The request breaks a side conversation rule
The company has not added side conversations
The caller may not do this
The project, conversation or side conversation is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId/status" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"status":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId/status', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"status": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId/status'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"status":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId/status",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"status":"string"},
)Open a support conversation
Opens a new conversation and returns a token scoped to it. The token is the only credential that authorizes reading or appending to the thread, and it is returned exactly once. Rate-limited per project key and per client IP.
Body
{
"distinctId": "string",
"subject?": "string | null",
"userId?": "string | null",
"userHash?": "string | null",
"fromArticle?": {
"pageId": "string",
"language": "string"
}
}Responses
The conversation and its token
{
"conversationId": "string",
"token": "string",
"expiresInSeconds": "integer"
}Invalid request body
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many conversations opened
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The conversation could not be opened
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://api.prodantix.com/v1/conversations" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"distinctId":"string","subject":"string","userId":"string","userHash":"string","fromArticle":"string"}'const response = await fetch('https://api.prodantix.com/v1/conversations', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"distinctId": "string",
"subject": "string",
"userId": "string",
"userHash": "string",
"fromArticle": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/conversations'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"distinctId":"string","subject":"string","userId":"string","userHash":"string","fromArticle":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/conversations",
headers={"Authorization": f"Bearer {project_key}"},
json={"distinctId":"string","subject":"string","userId":"string","userHash":"string","fromArticle":"string"},
)Append a message to a conversation
Appends an end-user turn. Requires the conversation token in the X-Prodantix-Conversation-Token header; the token is scoped to one conversation. attachmentIds names up to three files uploaded to this conversation and not yet sent; the body may be empty when the turn carries one.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id required | path | string | The conversation the token was minted for. |
Body
{
"body": "string",
"pageContext?": {
"host": "string",
"path": "string",
"title": "string"
},
"attachmentIds?": []
}Responses
The appended turn
{
"turn": {
"id": "string",
"authorKind": "string",
"authorId?": "string | null",
"body": "string",
"createdAt": "string",
"authorName?": "string | null",
"authorAvatarUrl?": "string | null",
"attachments": [
{
"id": "string",
"name": "string",
"contentType": "string",
"bytes": "integer",
"url": "string",
"removed": "boolean"
}
]
}
}Invalid request body
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key or conversation token
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}A named file is not this conversation's, or was already sent
{
"statusCode": "integer",
"message": "string",
"error": "string"
}More than 20 turns appended to this conversation in a minute
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The turn could not be appended
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://api.prodantix.com/v1/conversations/:id/turns" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"body":"string","pageContext":"string","attachmentIds":[]}'const response = await fetch('https://api.prodantix.com/v1/conversations/:id/turns', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"body": "string",
"pageContext": "string",
"attachmentIds": []
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/conversations/:id/turns'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"body":"string","pageContext":"string","attachmentIds":[]}),
);response = requests.post(
"https://api.prodantix.com/v1/conversations/:id/turns",
headers={"Authorization": f"Bearer {project_key}"},
json={"body":"string","pageContext":"string","attachmentIds":[]},
)Read a conversation thread
Returns the conversation and its latest turns, oldest first, with hasEarlier saying whether older ones exist. Requires the conversation token in the X-Prodantix-Conversation-Token header.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id required | path | string | The conversation the token was minted for. |
| limit | query | integer | How many of the latest turns to return: 100 by default, at most 500. |
| before | query | string | A turn id: returns the turns before it, for paging back through a long thread. |
Responses
The conversation thread
{
"id": "string",
"distinctId": "string",
"subject?": "string | null",
"status": "string",
"lastTurnAt": "string",
"createdAt": "string",
"turns": [
{
"id": "string",
"authorKind": "string",
"authorId?": "string | null",
"body": "string",
"createdAt": "string",
"authorName?": "string | null",
"authorAvatarUrl?": "string | null",
"attachments": [
{
"id": "string",
"name": "string",
"contentType": "string",
"bytes": "integer",
"url": "string",
"removed": "boolean"
}
]
}
],
"hasEarlier": "boolean"
}Missing or invalid project key or conversation token
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}More than 120 reads of this conversation in a minute
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The conversation could not be read
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/conversations/:id" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/conversations/:id', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/conversations/:id'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/conversations/:id",
headers={"Authorization": f"Bearer {project_key}"},
)Upload a file to a conversation
Stores a file the visitor will send with their next message. The request body is the file's raw bytes, at most 500,000, and must be a PNG, JPEG, WebP, GIF or PDF; the bytes decide the type, never the Content-Type header. Requires the conversation token in the X-Prodantix-Conversation-Token header, and a project that lets visitors send files.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id required | path | string | The conversation the token was minted for. |
| name | query | string | The file's name as the visitor chose it, shown to the team. Up to 200 characters; `file` when absent. |
Responses
The stored file, ready to send with a turn
{
"id": "string",
"name": "string",
"contentType": "string",
"bytes": "integer"
}The body could not be received (ATTACHMENT_UNREAD)
{
"error": {
"code": "string",
"message": "string"
}
}Missing or invalid project key or conversation token
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The project does not let visitors send files (ATTACHMENTS_OFF), or the key belongs to a different region
{
"error": {
"code": "string",
"message": "string"
}
}The file is larger than 500,000 bytes (ATTACHMENT_TOO_LARGE)
{
"error": {
"code": "string",
"message": "string"
}
}The file is not a PNG, JPEG, WebP, GIF or PDF (ATTACHMENT_FORMAT)
{
"error": {
"code": "string",
"message": "string"
}
}Too many files sent from this conversation or address (ATTACHMENT_RATE)
{
"error": {
"code": "string",
"message": "string"
}
}The file could not be taken (ATTACHMENT_FAILED)
{
"error": {
"code": "string",
"message": "string"
}
}The object store refused the file (ATTACHMENT_STORAGE)
{
"error": {
"code": "string",
"message": "string"
}
}File storage is not configured (ATTACHMENT_STORAGE)
{
"error": {
"code": "string",
"message": "string"
}
}Try it
curl -X POST "https://api.prodantix.com/v1/conversations/:id/attachments" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/conversations/:id/attachments', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/conversations/:id/attachments'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.post(
"https://api.prodantix.com/v1/conversations/:id/attachments",
headers={"Authorization": f"Bearer {project_key}"},
)Read a file sent in a conversation
Answers the file's bytes with the type it was stored as: a PDF as a download, an image to show in place, never sniffed and never cached by a shared cache. Requires the conversation token in the X-Prodantix-Conversation-Token header; a file of another conversation is not found.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id required | path | string | The conversation the token was minted for. |
| attachmentId required | path | string | The file, as a turn's attachments name it. |
Responses
The file's bytes
Missing or invalid project key or conversation token
{
"statusCode": "integer",
"message": "string",
"error": "string"
}No such file in this conversation (ATTACHMENT_NOT_FOUND)
{
"error": {
"code": "string",
"message": "string"
}
}The file could not be read (ATTACHMENT_FAILED)
{
"error": {
"code": "string",
"message": "string"
}
}The object store did not answer with the file (ATTACHMENT_STORAGE)
{
"error": {
"code": "string",
"message": "string"
}
}File storage is not configured (ATTACHMENT_STORAGE)
{
"error": {
"code": "string",
"message": "string"
}
}Try it
curl -X GET "https://api.prodantix.com/v1/conversations/:id/attachments/:attachmentId" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/conversations/:id/attachments/:attachmentId', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/conversations/:id/attachments/:attachmentId'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/conversations/:id/attachments/:attachmentId",
headers={"Authorization": f"Bearer {project_key}"},
)guides
List guides
A project's tours, tooltips and checklists that are not archived, most recently changed first.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the guide belongs to. |
Responses
The guides
{
"guides": [
{
"id": "string",
"name": "string",
"kind": "tour | tooltip | checklist",
"status": "draft | running | stopped | archived",
"steps": [
{
"id": "string",
"title": "string",
"body?": "string | null",
"anchor?": "string | null",
"selector?": "string | null",
"image?": "string | null",
"placement?": "auto | top | bottom | left | right | center",
"event?": "string | null",
"link?": "string | null"
}
],
"appearance": {
"accent?": "string | null",
"launcher?": "bottom_right | bottom_left",
"nextLabel?": "string | null",
"doneLabel?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"repeatDays?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}
]
}The guide is not valid
The caller may not do this
The project or guide is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/guides" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/guides', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/guides'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/guides",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a guide
Saves a draft tour, tooltip or checklist: its steps, appearance, targeting and schedule.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the guide belongs to. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"kind": "tour | tooltip | checklist",
"steps": [
{
"id": "string",
"title": "string",
"body?": "string | null",
"anchor?": "string | null",
"selector?": "string | null",
"image?": "string | null",
"placement?": "auto | top | bottom | left | right | center",
"event?": "string | null",
"link?": "string | null"
}
],
"appearance?": {
"accent?": "string | null",
"launcher?": "bottom_right | bottom_left",
"nextLabel?": "string | null",
"doneLabel?": "string | null"
},
"targeting?": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"repeatDays?": "integer | null",
"startsAt?": "string | null",
"endsAt?": "string | null"
}Responses
The guide as saved
{
"id": "string",
"name": "string",
"kind": "tour | tooltip | checklist",
"status": "draft | running | stopped | archived",
"steps": [
{
"id": "string",
"title": "string",
"body?": "string | null",
"anchor?": "string | null",
"selector?": "string | null",
"image?": "string | null",
"placement?": "auto | top | bottom | left | right | center",
"event?": "string | null",
"link?": "string | null"
}
],
"appearance": {
"accent?": "string | null",
"launcher?": "bottom_right | bottom_left",
"nextLabel?": "string | null",
"doneLabel?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"repeatDays?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The guide is not valid
The caller may not do this
The project or guide is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/guides" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","kind":"string","steps":[],"appearance":"string","targeting":"string","repeatDays":0,"startsAt":"string","endsAt":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/guides', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"kind": "string",
"steps": [],
"appearance": "string",
"targeting": "string",
"repeatDays": 0,
"startsAt": "string",
"endsAt": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/guides'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","kind":"string","steps":[],"appearance":"string","targeting":"string","repeatDays":0,"startsAt":"string","endsAt":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/guides",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","kind":"string","steps":[],"appearance":"string","targeting":"string","repeatDays":0,"startsAt":"string","endsAt":"string"},
)Read a guide
One guide with its steps, appearance, targeting and schedule.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the guide belongs to. |
| guideId required | path | string | The guide. |
Responses
The guide
{
"id": "string",
"name": "string",
"kind": "tour | tooltip | checklist",
"status": "draft | running | stopped | archived",
"steps": [
{
"id": "string",
"title": "string",
"body?": "string | null",
"anchor?": "string | null",
"selector?": "string | null",
"image?": "string | null",
"placement?": "auto | top | bottom | left | right | center",
"event?": "string | null",
"link?": "string | null"
}
],
"appearance": {
"accent?": "string | null",
"launcher?": "bottom_right | bottom_left",
"nextLabel?": "string | null",
"doneLabel?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"repeatDays?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The guide is not valid
The caller may not do this
The project or guide is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/guides/:guideId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Change a guide
Replaces a guide's name, steps, appearance, targeting and schedule.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the guide belongs to. |
| guideId required | path | string | The guide. |
Body
{
"name": "string",
"kind": "tour | tooltip | checklist",
"steps": [
{
"id": "string",
"title": "string",
"body?": "string | null",
"anchor?": "string | null",
"selector?": "string | null",
"image?": "string | null",
"placement?": "auto | top | bottom | left | right | center",
"event?": "string | null",
"link?": "string | null"
}
],
"appearance?": {
"accent?": "string | null",
"launcher?": "bottom_right | bottom_left",
"nextLabel?": "string | null",
"doneLabel?": "string | null"
},
"targeting?": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"repeatDays?": "integer | null",
"startsAt?": "string | null",
"endsAt?": "string | null"
}Responses
The guide as saved
{
"id": "string",
"name": "string",
"kind": "tour | tooltip | checklist",
"status": "draft | running | stopped | archived",
"steps": [
{
"id": "string",
"title": "string",
"body?": "string | null",
"anchor?": "string | null",
"selector?": "string | null",
"image?": "string | null",
"placement?": "auto | top | bottom | left | right | center",
"event?": "string | null",
"link?": "string | null"
}
],
"appearance": {
"accent?": "string | null",
"launcher?": "bottom_right | bottom_left",
"nextLabel?": "string | null",
"doneLabel?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"repeatDays?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The guide is not valid
The caller may not do this
The project or guide is not there
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","kind":"string","steps":[],"appearance":"string","targeting":"string","repeatDays":0,"startsAt":"string","endsAt":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"kind": "string",
"steps": [],
"appearance": "string",
"targeting": "string",
"repeatDays": 0,
"startsAt": "string",
"endsAt": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","kind":"string","steps":[],"appearance":"string","targeting":"string","repeatDays":0,"startsAt":"string","endsAt":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/guides/:guideId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","kind":"string","steps":[],"appearance":"string","targeting":"string","repeatDays":0,"startsAt":"string","endsAt":"string"},
)Start a guide
Shows the guide to the visitors it targets from its start time.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the guide belongs to. |
| guideId required | path | string | The guide. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The running guide
{
"id": "string",
"name": "string",
"kind": "tour | tooltip | checklist",
"status": "draft | running | stopped | archived",
"steps": [
{
"id": "string",
"title": "string",
"body?": "string | null",
"anchor?": "string | null",
"selector?": "string | null",
"image?": "string | null",
"placement?": "auto | top | bottom | left | right | center",
"event?": "string | null",
"link?": "string | null"
}
],
"appearance": {
"accent?": "string | null",
"launcher?": "bottom_right | bottom_left",
"nextLabel?": "string | null",
"doneLabel?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"repeatDays?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The guide is not valid
The caller may not do this
The project or guide is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/start" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/start', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/start'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/start",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Stop a guide
Stops showing the guide; its results stay.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the guide belongs to. |
| guideId required | path | string | The guide. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The stopped guide
{
"id": "string",
"name": "string",
"kind": "tour | tooltip | checklist",
"status": "draft | running | stopped | archived",
"steps": [
{
"id": "string",
"title": "string",
"body?": "string | null",
"anchor?": "string | null",
"selector?": "string | null",
"image?": "string | null",
"placement?": "auto | top | bottom | left | right | center",
"event?": "string | null",
"link?": "string | null"
}
],
"appearance": {
"accent?": "string | null",
"launcher?": "bottom_right | bottom_left",
"nextLabel?": "string | null",
"doneLabel?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"repeatDays?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The guide is not valid
The caller may not do this
The project or guide is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/stop" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/stop', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/stop'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/stop",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Archive a guide
Removes the guide from the list; its results stay in the events.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the guide belongs to. |
| guideId required | path | string | The guide. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The archived guide
{
"id": "string",
"name": "string",
"kind": "tour | tooltip | checklist",
"status": "draft | running | stopped | archived",
"steps": [
{
"id": "string",
"title": "string",
"body?": "string | null",
"anchor?": "string | null",
"selector?": "string | null",
"image?": "string | null",
"placement?": "auto | top | bottom | left | right | center",
"event?": "string | null",
"link?": "string | null"
}
],
"appearance": {
"accent?": "string | null",
"launcher?": "bottom_right | bottom_left",
"nextLabel?": "string | null",
"doneLabel?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"repeatDays?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The guide is not valid
The caller may not do this
The project or guide is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/archive" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/archive', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/archive'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/archive",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Duplicate a guide
Saves a draft copy of a guide.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the guide belongs to. |
| guideId required | path | string | The guide. |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The copy
{
"id": "string",
"name": "string",
"kind": "tour | tooltip | checklist",
"status": "draft | running | stopped | archived",
"steps": [
{
"id": "string",
"title": "string",
"body?": "string | null",
"anchor?": "string | null",
"selector?": "string | null",
"image?": "string | null",
"placement?": "auto | top | bottom | left | right | center",
"event?": "string | null",
"link?": "string | null"
}
],
"appearance": {
"accent?": "string | null",
"launcher?": "bottom_right | bottom_left",
"nextLabel?": "string | null",
"doneLabel?": "string | null"
},
"targeting": {
"urls?": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"cohortIds?": [],
"flagKey?": "string | null",
"flagVariant?": "string | null",
"event?": "string | null",
"waitDays?": "integer",
"showOnce?": "boolean"
},
"repeatDays?": "integer | null",
"iteration": "integer",
"startsAt?": "string | null",
"endsAt?": "string | null",
"createdAt": "string",
"updatedAt": "string"
}The guide is not valid
The caller may not do this
The project or guide is not there
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/duplicate" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/duplicate', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/duplicate'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/duplicate",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a guide's results
Who saw, finished and dismissed a round of the guide, and how many visitors reached each step. `iteration` picks a round; the current one by default.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the guide belongs to. |
| guideId required | path | string | The guide. |
| iteration | query | integer | The round to read. |
Responses
The results
{
"shown": "integer",
"completed": "integer",
"dismissed": "integer",
"missed": "integer",
"steps": [
{
"stepId": "string",
"visitors": "integer"
}
]
}The guide is not valid
The caller may not do this
The project or guide is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/results" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/results', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/results'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/results",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Count each guide's reach
How many visitors each of the project's guides was shown to and how many finished it, over every round.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the guide belongs to. |
Responses
The counts, one per guide shown at least once
{
"guides": [
{
"guideId": "string",
"reached": "integer",
"completed": "integer"
}
]
}The guide is not valid
The caller may not do this
The project or guide is not there
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/guides/reach" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/guides/reach', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/guides/reach'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/guides/reach",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the guides a visitor qualifies for
Answers the running tours, tooltips and checklists whose schedule, cohorts and flag the distinct id meets, with their steps, appearance and the page rules the SDK applies itself. A project with no running guide answers an empty list.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| distinct_id required | query | string | The visitor's distinct id. |
Responses
The guides the visitor qualifies for
{
"guides": [
{
"id": "string",
"name": "string",
"kind": "tour | tooltip | checklist",
"iteration": "integer",
"steps": [
{
"id": "string",
"title": "string",
"body?": "string | null",
"anchor?": "string | null",
"selector?": "string | null",
"image?": "string | null",
"placement?": "auto | top | bottom | left | right | center",
"event?": "string | null",
"link?": "string | null"
}
],
"appearance": {
"accent?": "string | null",
"launcher?": "bottom_right | bottom_left",
"nextLabel?": "string | null",
"doneLabel?": "string | null"
},
"urls": [
{
"matches": "exact | contains | starts_with",
"value": "string"
}
],
"event?": "string | null",
"waitDays": "integer",
"showOnce": "boolean"
}
]
}The distinct id is missing or too long
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The guides could not be read
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/guides" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/guides', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/guides'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/guides",
headers={"Authorization": f"Bearer {project_key}"},
)events
List ingest transformations
The project's transformations in the order they run, with how many events each matched today and yesterday.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the transformations belong to |
Responses
200 The transformations
{
"transformations": [
{
"id": "string",
"position": "integer",
"name": "string",
"event": "string",
"action": "unknown",
"enabled": "boolean",
"matchedToday": "integer",
"matchedYesterday": "integer",
"updatedAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/transformations" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/transformations', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/transformations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/transformations",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create an ingest transformation
Adds a transformation at the end of the order: drop, rename, remove, hash or require. Arriving events see it within a minute.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the transformations belong to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"event": "string",
"action": "unknown",
"enabled?": "boolean | null"
}Responses
The transformation
{
"id": "string",
"position": "integer",
"name": "string",
"event": "string",
"action": "unknown",
"enabled": "boolean",
"matchedToday": "integer",
"matchedYesterday": "integer",
"updatedAt": "string"
}The transformation is invalid, or the project already holds 50
The caller may not manage the project's events
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/transformations" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","event":"string","action":"string","enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/transformations', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"event": "string",
"action": "string",
"enabled": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/transformations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","event":"string","action":"string","enabled":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/transformations",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","event":"string","action":"string","enabled":true},
)Update an ingest transformation
Replaces a transformation's name, match and action, and switches it on or off.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the transformations belong to |
| transformationId required | path | string | The transformation's id |
Body
{
"name": "string",
"event": "string",
"action": "unknown",
"enabled?": "boolean | null"
}Responses
The transformation
{
"id": "string",
"position": "integer",
"name": "string",
"event": "string",
"action": "unknown",
"enabled": "boolean",
"matchedToday": "integer",
"matchedYesterday": "integer",
"updatedAt": "string"
}The transformation is invalid
No such transformation
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","event":"string","action":"string","enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"event": "string",
"action": "string",
"enabled": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","event":"string","action":"string","enabled":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","event":"string","action":"string","enabled":true},
)Delete an ingest transformation
Removes a transformation; the ones after it move up.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the transformations belong to |
| transformationId required | path | string | The transformation's id |
Responses
Deleted
No such transformation
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Move an ingest transformation
Moves a transformation to a position in the order, 0 running first.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the transformations belong to |
| transformationId required | path | string | The transformation's id |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"position": "integer"
}Responses
The transformations in their new order
{
"transformations": [
{
"id": "string",
"position": "integer",
"name": "string",
"event": "string",
"action": "unknown",
"enabled": "boolean",
"matchedToday": "integer",
"matchedYesterday": "integer",
"updatedAt": "string"
}
]
}No such transformation
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId/move" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"position":0}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId/move', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"position": 0
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId/move'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"position":0}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId/move",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"position":0},
)Test ingest transformations
Runs a sample event through the project's enabled transformations and answers what would be stored. Nothing is stored.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the transformations belong to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"eventName": "string",
"distinctId?": "string | null",
"properties?": "object"
}Responses
200 The event after the transformations
{
"dropped": "boolean",
"properties": "object",
"applied": []
}Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/transformations/test" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"eventName":"string","distinctId":"string","properties":{}}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/transformations/test', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"eventName": "string",
"distinctId": "string",
"properties": {}
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/transformations/test'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"eventName":"string","distinctId":"string","properties":{}}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/transformations/test",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"eventName":"string","distinctId":"string","properties":{}},
)List event streams
The endpoints a project forwards its arriving events to. The destination URL is sealed and only its host is returned.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the stream belongs to |
Responses
200 The streams
{
"streams": [
{
"id": "string",
"name": "string",
"events": [],
"host": "string",
"enabled": "boolean",
"delivered": "integer",
"dropped": "integer",
"waiting": "integer",
"lastSuccessAt?": "string | null",
"lastError?": "string | null",
"createdAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/event-streams" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/event-streams', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/event-streams'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/event-streams",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create an event stream
Forwards a project's arriving events, after its transformations, to a signed https webhook in batches of up to 500 within about a second.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the stream belongs to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"events?": [],
"url?": "string | null",
"enabled?": "boolean | null"
}Responses
The stream
{
"id": "string",
"name": "string",
"events": [],
"host": "string",
"enabled": "boolean",
"delivered": "integer",
"dropped": "integer",
"waiting": "integer",
"lastSuccessAt?": "string | null",
"lastError?": "string | null",
"createdAt": "string"
}The stream is invalid, or the project already holds 10
The caller may not stream events
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/event-streams" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","events":[],"url":"string","enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/event-streams', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"events": [],
"url": "string",
"enabled": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/event-streams'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","events":[],"url":"string","enabled":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/event-streams",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","events":[],"url":"string","enabled":true},
)Update an event stream
Renames a stream, changes the events it forwards or its destination, or switches it on or off.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the stream belongs to |
| streamId required | path | string | The stream's id |
Body
{
"name": "string",
"events?": [],
"url?": "string | null",
"enabled?": "boolean | null"
}Responses
The stream
{
"id": "string",
"name": "string",
"events": [],
"host": "string",
"enabled": "boolean",
"delivered": "integer",
"dropped": "integer",
"waiting": "integer",
"lastSuccessAt?": "string | null",
"lastError?": "string | null",
"createdAt": "string"
}No such stream
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/event-streams/:streamId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","events":[],"url":"string","enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/event-streams/:streamId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"events": [],
"url": "string",
"enabled": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/event-streams/:streamId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","events":[],"url":"string","enabled":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/event-streams/:streamId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","events":[],"url":"string","enabled":true},
)Delete an event stream
Stops a stream; its parked batches are dropped.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the stream belongs to |
| streamId required | path | string | The stream's id |
Responses
Deleted
No such stream
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/event-streams/:streamId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/event-streams/:streamId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/event-streams/:streamId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/event-streams/:streamId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Ingest a batch of events
Accepts a batch of analytics events. A 202 means accepted for processing, not persisted.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"api_key?": "string | null",
"events": [
{
"context?": {
"locale?": "string | null",
"os?": "string | null",
"sdk?": "string | null",
"sdk_version?": "string | null"
},
"distinct_id": "string",
"event_id": "string",
"event_name": "string",
"properties?": "object",
"schema_version": "integer",
"session_id?": "string | null",
"timestamp": "string"
}
],
"sent_at": "string"
}Responses
Accepted for processing
{
"accepted": "integer"
}Malformed JSON or invalid payload
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://eu.api.prodantix.com/v1/events" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"api_key":"string","events":[],"sent_at":"string"}'const response = await fetch('https://eu.api.prodantix.com/v1/events', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"api_key": "string",
"events": [],
"sent_at": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://eu.api.prodantix.com/v1/events'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"api_key":"string","events":[],"sent_at":"string"}),
);response = requests.post(
"https://eu.api.prodantix.com/v1/events",
headers={"Authorization": f"Bearer {project_key}"},
json={"api_key":"string","events":[],"sent_at":"string"},
)Identify a user
Associates traits with a distinct id. A 202 means accepted for processing, not persisted.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"distinct_id?": "string | null",
"event_id?": "string | null",
"properties?": "object | null",
"timestamp?": "string | null"
}Responses
Accepted for processing
{
"accepted": "integer"
}Malformed JSON or invalid payload
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://eu.api.prodantix.com/v1/identify" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"distinct_id":"string","event_id":"string","properties":{},"timestamp":"string"}'const response = await fetch('https://eu.api.prodantix.com/v1/identify', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"distinct_id": "string",
"event_id": "string",
"properties": {},
"timestamp": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://eu.api.prodantix.com/v1/identify'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"distinct_id":"string","event_id":"string","properties":{},"timestamp":"string"}),
);response = requests.post(
"https://eu.api.prodantix.com/v1/identify",
headers={"Authorization": f"Bearer {project_key}"},
json={"distinct_id":"string","event_id":"string","properties":{},"timestamp":"string"},
)Associate a user with a group
Associates a distinct id with a group and its traits. A 202 means accepted for processing, not persisted.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"distinct_id?": "string | null",
"event_id?": "string | null",
"properties?": "object | null",
"timestamp?": "string | null"
}Responses
Accepted for processing
{
"accepted": "integer"
}Malformed JSON or invalid payload
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://eu.api.prodantix.com/v1/group" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"distinct_id":"string","event_id":"string","properties":{},"timestamp":"string"}'const response = await fetch('https://eu.api.prodantix.com/v1/group', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"distinct_id": "string",
"event_id": "string",
"properties": {},
"timestamp": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://eu.api.prodantix.com/v1/group'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"distinct_id":"string","event_id":"string","properties":{},"timestamp":"string"}),
);response = requests.post(
"https://eu.api.prodantix.com/v1/group",
headers={"Authorization": f"Bearer {project_key}"},
json={"distinct_id":"string","event_id":"string","properties":{},"timestamp":"string"},
)Ingest a Segment-format call
Accepts Segment's HTTP tracking API: track, identify, page, screen, group, alias and batch, or their one-letter forms. The project key travels as Segment's write key in Basic auth, as a Bearer header, or as `writeKey` in the body.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| call required | path | string | track, identify, page, screen, group, alias or batch, or t, i, p, s, g, a or b; webhook for one message of any type, as Segment's Webhooks destination posts it |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
Accepted for processing, in Segment's own answer
{
"success": "boolean"
}Malformed JSON, an unknown call or a message over Segment's limits
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://eu.api.prodantix.com/segment/v1/:call" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://eu.api.prodantix.com/segment/v1/:call', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://eu.api.prodantix.com/segment/v1/:call'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.post(
"https://eu.api.prodantix.com/segment/v1/:call",
headers={"Authorization": f"Bearer {project_key}"},
)campaigns
List campaigns
A project's campaigns, newest first, each with its spend in the project's currency and its asset count. Archived campaigns are left out unless includeArchived is true.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| includeArchived | query | boolean | Whether archived campaigns are listed too |
Responses
200 The campaigns
{
"campaigns": [
{
"id": "string",
"name": "string",
"utmCampaign": "string",
"owner?": "string | null",
"startsOn?": "string | null",
"endsOn?": "string | null",
"colour": "string",
"notes": "string",
"budgetAmount?": "string | null",
"budgetCurrency?": "string | null",
"goalContacts?": "integer | null",
"goalDeals?": "integer | null",
"goalRevenue?": "string | null",
"currency": "string",
"spent": "string",
"unconvertedSpendLines": "integer",
"assetCount": "integer",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt?": "string | null"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/campaigns" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/campaigns",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a campaign
Creates a campaign under a utm_campaign key unique in the project.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"utmCampaign": "string",
"owner?": "string | null",
"startsOn?": "string | null",
"endsOn?": "string | null",
"colour": "string",
"notes?": "string",
"budgetAmount?": "string | null",
"budgetCurrency?": "string | null",
"goalContacts?": "integer | null",
"goalDeals?": "integer | null",
"goalRevenue?": "string | null"
}Responses
The campaign
{
"id": "string",
"name": "string",
"utmCampaign": "string",
"owner?": "string | null",
"startsOn?": "string | null",
"endsOn?": "string | null",
"colour": "string",
"notes": "string",
"budgetAmount?": "string | null",
"budgetCurrency?": "string | null",
"goalContacts?": "integer | null",
"goalDeals?": "integer | null",
"goalRevenue?": "string | null",
"currency": "string",
"spent": "string",
"unconvertedSpendLines": "integer",
"assetCount": "integer",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt?": "string | null"
}A field is invalid
Campaigns are not in the plan
Another campaign uses the key
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/campaigns" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","utmCampaign":"string","owner":"string","startsOn":"string","endsOn":"string","colour":"string","notes":"string","budgetAmount":"string","budgetCurrency":"string","goalContacts":0,"goalDeals":0,"goalRevenue":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"utmCampaign": "string",
"owner": "string",
"startsOn": "string",
"endsOn": "string",
"colour": "string",
"notes": "string",
"budgetAmount": "string",
"budgetCurrency": "string",
"goalContacts": 0,
"goalDeals": 0,
"goalRevenue": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","utmCampaign":"string","owner":"string","startsOn":"string","endsOn":"string","colour":"string","notes":"string","budgetAmount":"string","budgetCurrency":"string","goalContacts":0,"goalDeals":0,"goalRevenue":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/campaigns",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","utmCampaign":"string","owner":"string","startsOn":"string","endsOn":"string","colour":"string","notes":"string","budgetAmount":"string","budgetCurrency":"string","goalContacts":0,"goalDeals":0,"goalRevenue":"string"},
)Read a campaign
A campaign with its spend in the project's currency and its asset count.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| campaignId required | path | string | The campaign |
Responses
The campaign
{
"id": "string",
"name": "string",
"utmCampaign": "string",
"owner?": "string | null",
"startsOn?": "string | null",
"endsOn?": "string | null",
"colour": "string",
"notes": "string",
"budgetAmount?": "string | null",
"budgetCurrency?": "string | null",
"goalContacts?": "integer | null",
"goalDeals?": "integer | null",
"goalRevenue?": "string | null",
"currency": "string",
"spent": "string",
"unconvertedSpendLines": "integer",
"assetCount": "integer",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt?": "string | null"
}No such campaign
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Update a campaign
Replaces a campaign's name, key, owner, dates, colour, notes, budget and goals.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| campaignId required | path | string | The campaign |
Body
{
"name": "string",
"utmCampaign": "string",
"owner?": "string | null",
"startsOn?": "string | null",
"endsOn?": "string | null",
"colour": "string",
"notes?": "string",
"budgetAmount?": "string | null",
"budgetCurrency?": "string | null",
"goalContacts?": "integer | null",
"goalDeals?": "integer | null",
"goalRevenue?": "string | null"
}Responses
The campaign
{
"id": "string",
"name": "string",
"utmCampaign": "string",
"owner?": "string | null",
"startsOn?": "string | null",
"endsOn?": "string | null",
"colour": "string",
"notes": "string",
"budgetAmount?": "string | null",
"budgetCurrency?": "string | null",
"goalContacts?": "integer | null",
"goalDeals?": "integer | null",
"goalRevenue?": "string | null",
"currency": "string",
"spent": "string",
"unconvertedSpendLines": "integer",
"assetCount": "integer",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt?": "string | null"
}A field is invalid
No such campaign
Another campaign uses the key
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","utmCampaign":"string","owner":"string","startsOn":"string","endsOn":"string","colour":"string","notes":"string","budgetAmount":"string","budgetCurrency":"string","goalContacts":0,"goalDeals":0,"goalRevenue":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"utmCampaign": "string",
"owner": "string",
"startsOn": "string",
"endsOn": "string",
"colour": "string",
"notes": "string",
"budgetAmount": "string",
"budgetCurrency": "string",
"goalContacts": 0,
"goalDeals": 0,
"goalRevenue": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","utmCampaign":"string","owner":"string","startsOn":"string","endsOn":"string","colour":"string","notes":"string","budgetAmount":"string","budgetCurrency":"string","goalContacts":0,"goalDeals":0,"goalRevenue":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","utmCampaign":"string","owner":"string","startsOn":"string","endsOn":"string","colour":"string","notes":"string","budgetAmount":"string","budgetCurrency":"string","goalContacts":0,"goalDeals":0,"goalRevenue":"string"},
)Archive a campaign
Takes a campaign out of the list; its assets, spend and tracking links stay.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| campaignId required | path | string | The campaign |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The campaign
{
"id": "string",
"name": "string",
"utmCampaign": "string",
"owner?": "string | null",
"startsOn?": "string | null",
"endsOn?": "string | null",
"colour": "string",
"notes": "string",
"budgetAmount?": "string | null",
"budgetCurrency?": "string | null",
"goalContacts?": "integer | null",
"goalDeals?": "integer | null",
"goalRevenue?": "string | null",
"currency": "string",
"spent": "string",
"unconvertedSpendLines": "integer",
"assetCount": "integer",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt?": "string | null"
}No such campaign
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/archive" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/archive', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/archive'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/archive",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Restore a campaign
Brings an archived campaign back into the list.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| campaignId required | path | string | The campaign |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The campaign
{
"id": "string",
"name": "string",
"utmCampaign": "string",
"owner?": "string | null",
"startsOn?": "string | null",
"endsOn?": "string | null",
"colour": "string",
"notes": "string",
"budgetAmount?": "string | null",
"budgetCurrency?": "string | null",
"goalContacts?": "integer | null",
"goalDeals?": "integer | null",
"goalRevenue?": "string | null",
"currency": "string",
"spent": "string",
"unconvertedSpendLines": "integer",
"assetCount": "integer",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt?": "string | null"
}No such campaign
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/restore" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/restore', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/restore'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/restore",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List a campaign's assets
The emails, messages, forms, CTAs, landing pages, workflows, events and tracking links a campaign groups.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| campaignId required | path | string | The campaign |
Responses
The assets
{
"assets": [
{
"campaignId": "string",
"kind": "string",
"assetId": "string",
"addedBy": "string",
"addedAt": "string",
"name?": "string | null",
"momentKind?": "string | null",
"momentAt?": "string | null"
}
]
}No such campaign
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/assets" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/assets', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/assets'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/assets",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add an asset to a campaign
An asset belongs to one campaign. Adding one already in this campaign changes nothing; one held by another campaign is refused with that campaign's id in details.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| campaignId required | path | string | The campaign |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"kind": "string",
"assetId": "string"
}Responses
The asset
{
"campaignId": "string",
"kind": "string",
"assetId": "string",
"addedBy": "string",
"addedAt": "string",
"name?": "string | null",
"momentKind?": "string | null",
"momentAt?": "string | null"
}No such campaign or asset
Another campaign holds the asset
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/assets" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"kind":"string","assetId":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/assets', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"kind": "string",
"assetId": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/assets'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"kind":"string","assetId":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/assets",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"kind":"string","assetId":"string"},
)Remove an asset from a campaign
Takes an asset out of a campaign; the asset itself stays.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| campaignId required | path | string | The campaign |
| kind required | path | string | The asset's kind |
| assetId required | path | string | The asset |
Responses
Removed
No such asset in the campaign
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/assets/:kind/:assetId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/assets/:kind/:assetId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/assets/:kind/:assetId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/assets/:kind/:assetId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List a campaign's spend
A campaign's spend lines, each with its amount in the project's currency, none when no exchange rate converts it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| campaignId required | path | string | The campaign |
Responses
The spend lines
{
"spend": [
{
"id": "string",
"campaignId": "string",
"amount": "string",
"currency": "string",
"converted?": "string | null",
"spentOn": "string",
"note": "string",
"source": "string",
"createdBy": "string",
"createdAt": "string"
}
]
}No such campaign
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/spend" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/spend', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/spend'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/spend",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add a spend line
Records an amount spent on a campaign on a day, in any currency.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| campaignId required | path | string | The campaign |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"amount": "string",
"currency": "string",
"spentOn": "string",
"note?": "string"
}Responses
The spend line
{
"id": "string",
"campaignId": "string",
"amount": "string",
"currency": "string",
"converted?": "string | null",
"spentOn": "string",
"note": "string",
"source": "string",
"createdBy": "string",
"createdAt": "string"
}A field is invalid
No such campaign
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/spend" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"amount":"string","currency":"string","spentOn":"string","note":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/spend', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"amount": "string",
"currency": "string",
"spentOn": "string",
"note": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/spend'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"amount":"string","currency":"string","spentOn":"string","note":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/spend",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"amount":"string","currency":"string","spentOn":"string","note":"string"},
)Update a spend line
Replaces a spend line's amount, currency, day and note.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| spendId required | path | string | The spend line |
Body
{
"amount": "string",
"currency": "string",
"spentOn": "string",
"note?": "string"
}Responses
The spend line
{
"id": "string",
"campaignId": "string",
"amount": "string",
"currency": "string",
"converted?": "string | null",
"spentOn": "string",
"note": "string",
"source": "string",
"createdBy": "string",
"createdAt": "string"
}A field is invalid
No such spend line
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/campaign-spend/:spendId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"amount":"string","currency":"string","spentOn":"string","note":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaign-spend/:spendId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"amount": "string",
"currency": "string",
"spentOn": "string",
"note": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaign-spend/:spendId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"amount":"string","currency":"string","spentOn":"string","note":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/campaign-spend/:spendId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"amount":"string","currency":"string","spentOn":"string","note":"string"},
)Delete a spend line
Removes a spend line from its campaign.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| spendId required | path | string | The spend line |
Responses
Deleted
No such spend line
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/campaign-spend/:spendId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaign-spend/:spendId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaign-spend/:spendId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/campaign-spend/:spendId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List a campaign's tracking links
Each link's destination, UTM parameters and the built URL to share.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| campaignId required | path | string | The campaign |
Responses
The tracking links
{
"trackingUrls": [
{
"id": "string",
"campaignId": "string",
"destination": "string",
"utmSource": "string",
"utmMedium": "string",
"utmTerm?": "string | null",
"utmContent?": "string | null",
"url": "string",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}No such campaign
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/tracking-urls" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/tracking-urls', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/tracking-urls'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/tracking-urls",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a tracking link
Builds a link to an http or https destination carrying the campaign's key and the given UTM parameters in place of the destination's own; the link joins the campaign's assets.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| campaignId required | path | string | The campaign |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"destination": "string",
"utmSource": "string",
"utmMedium": "string",
"utmTerm?": "string | null",
"utmContent?": "string | null"
}Responses
The tracking link
{
"id": "string",
"campaignId": "string",
"destination": "string",
"utmSource": "string",
"utmMedium": "string",
"utmTerm?": "string | null",
"utmContent?": "string | null",
"url": "string",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string"
}The destination or a parameter is invalid
No such campaign
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/tracking-urls" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"destination":"string","utmSource":"string","utmMedium":"string","utmTerm":"string","utmContent":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/tracking-urls', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"destination": "string",
"utmSource": "string",
"utmMedium": "string",
"utmTerm": "string",
"utmContent": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/tracking-urls'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"destination":"string","utmSource":"string","utmMedium":"string","utmTerm":"string","utmContent":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/tracking-urls",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"destination":"string","utmSource":"string","utmMedium":"string","utmTerm":"string","utmContent":"string"},
)Update a tracking link
Replaces a tracking link's destination and UTM parameters.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| trackingUrlId required | path | string | The tracking link |
Body
{
"destination": "string",
"utmSource": "string",
"utmMedium": "string",
"utmTerm?": "string | null",
"utmContent?": "string | null"
}Responses
The tracking link
{
"id": "string",
"campaignId": "string",
"destination": "string",
"utmSource": "string",
"utmMedium": "string",
"utmTerm?": "string | null",
"utmContent?": "string | null",
"url": "string",
"createdBy": "string",
"createdAt": "string",
"updatedAt": "string"
}The destination or a parameter is invalid
No such tracking link
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/tracking-urls/:trackingUrlId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"destination":"string","utmSource":"string","utmMedium":"string","utmTerm":"string","utmContent":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/tracking-urls/:trackingUrlId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"destination": "string",
"utmSource": "string",
"utmMedium": "string",
"utmTerm": "string",
"utmContent": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/tracking-urls/:trackingUrlId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"destination":"string","utmSource":"string","utmMedium":"string","utmTerm":"string","utmContent":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/tracking-urls/:trackingUrlId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"destination":"string","utmSource":"string","utmMedium":"string","utmTerm":"string","utmContent":"string"},
)Delete a tracking link
Deletes a tracking link and takes it out of its campaign's assets.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| trackingUrlId required | path | string | The tracking link |
Responses
Deleted
No such tracking link
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/tracking-urls/:trackingUrlId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/tracking-urls/:trackingUrlId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/tracking-urls/:trackingUrlId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/tracking-urls/:trackingUrlId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List the dated assets of every campaign
The assets of every campaign that is not archived whose email, push or SMS was sent or is scheduled, whose landing page was published or whose marketing event starts on a UTC day from `from` to `to`, earliest first, 2,000 at most.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| from required | query | string | The first day, YYYY-MM-DD |
| to required | query | string | The last day, YYYY-MM-DD, at most 365 days after the first |
Responses
The dated assets
{
"assets": [
{
"campaignId": "string",
"kind": "string",
"assetId": "string",
"addedBy": "string",
"addedAt": "string",
"name?": "string | null",
"momentKind?": "string | null",
"momentAt?": "string | null"
}
]
}A day is invalid or the window is over 366 days
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/campaign-calendar" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaign-calendar', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaign-calendar'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/campaign-calendar",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List saved campaign views
The saved views of the Campaigns page the caller can see: their own and the project's, in their order.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
Responses
200 The views
{
"views": [
{
"id": "string",
"name": "string",
"ownerSub": "string",
"visibility": "string",
"statuses": [],
"owners": [],
"sortBy?": "string | null",
"sortDescending": "boolean",
"layout": "string",
"boardProperty?": "string | null",
"calendarProperty?": "string | null",
"position": "integer",
"canChange": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/campaign-views" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaign-views', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaign-views'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/campaign-views",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Save a campaign view
Saves a view of the Campaigns page: the statuses and owners it keeps, its sort, and its table, board or calendar layout. A private view is its owner's alone; a project view is everyone's to read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"visibility": "string",
"statuses?": [],
"owners?": [],
"sortBy?": "string | null",
"sortDescending?": "boolean",
"layout": "string",
"boardProperty?": "string | null",
"calendarProperty?": "string | null"
}Responses
The view
{
"id": "string",
"name": "string",
"ownerSub": "string",
"visibility": "string",
"statuses": [],
"owners": [],
"sortBy?": "string | null",
"sortDescending": "boolean",
"layout": "string",
"boardProperty?": "string | null",
"calendarProperty?": "string | null",
"position": "integer",
"canChange": "boolean",
"createdAt": "string",
"updatedAt": "string"
}A field is invalid
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/campaign-views" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","visibility":"string","statuses":[],"owners":[],"sortBy":"string","sortDescending":true,"layout":"string","boardProperty":"string","calendarProperty":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaign-views', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"visibility": "string",
"statuses": [],
"owners": [],
"sortBy": "string",
"sortDescending": true,
"layout": "string",
"boardProperty": "string",
"calendarProperty": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaign-views'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","visibility":"string","statuses":[],"owners":[],"sortBy":"string","sortDescending":true,"layout":"string","boardProperty":"string","calendarProperty":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/campaign-views",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","visibility":"string","statuses":[],"owners":[],"sortBy":"string","sortDescending":true,"layout":"string","boardProperty":"string","calendarProperty":"string"},
)Change a campaign view
Rewrites a view. Open to its owner, and on a project view to holders of prodantix.views.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| viewId required | path | string | The saved view |
Body
{
"name": "string",
"visibility": "string",
"statuses?": [],
"owners?": [],
"sortBy?": "string | null",
"sortDescending?": "boolean",
"layout": "string",
"boardProperty?": "string | null",
"calendarProperty?": "string | null"
}Responses
The view
{
"id": "string",
"name": "string",
"ownerSub": "string",
"visibility": "string",
"statuses": [],
"owners": [],
"sortBy?": "string | null",
"sortDescending": "boolean",
"layout": "string",
"boardProperty?": "string | null",
"calendarProperty?": "string | null",
"position": "integer",
"canChange": "boolean",
"createdAt": "string",
"updatedAt": "string"
}A field is invalid
The caller may read the view but not change it
No such view
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/campaign-views/:viewId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","visibility":"string","statuses":[],"owners":[],"sortBy":"string","sortDescending":true,"layout":"string","boardProperty":"string","calendarProperty":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaign-views/:viewId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"visibility": "string",
"statuses": [],
"owners": [],
"sortBy": "string",
"sortDescending": true,
"layout": "string",
"boardProperty": "string",
"calendarProperty": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaign-views/:viewId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","visibility":"string","statuses":[],"owners":[],"sortBy":"string","sortDescending":true,"layout":"string","boardProperty":"string","calendarProperty":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/campaign-views/:viewId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","visibility":"string","statuses":[],"owners":[],"sortBy":"string","sortDescending":true,"layout":"string","boardProperty":"string","calendarProperty":"string"},
)Delete a campaign view
Deletes a view. Open to its owner, and on a project view to holders of prodantix.views.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the campaigns belong to |
| viewId required | path | string | The saved view |
Responses
Deleted
The caller may read the view but not delete it
No such view
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/campaign-views/:viewId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaign-views/:viewId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaign-views/:viewId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/campaign-views/:viewId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read attribution
The credit a model gives each value of a dimension for the outcomes in a range: contacts created, deals created, or revenue in the project's currency, from each person's sessions, email clicks, form submissions and CTA clicks within the lookback before the outcome.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| model required | query | string | first_interaction, last_interaction, linear, u_shaped, w_shaped (deal and revenue), full_path (revenue), j_shaped, inverse_j_shaped or time_decay |
| outcome required | query | string | contact, deal or revenue |
| dimension required | query | string | campaign, channel, source, medium, utm_campaign, asset or touch_type |
| from required | query | string | The start of the range, an RFC 3339 instant |
| to required | query | string | The end of the range, an RFC 3339 instant |
| lookbackDays | query | integer | Days of touches before each outcome, 1 to 365; 90 when left out |
Responses
The report
{
"rows": [
{
"key": "string",
"credit": "number",
"label?": "string | null",
"touches": "integer",
"outcomesTouched": "integer"
}
],
"outcomes": "integer",
"excluded": "integer",
"withoutTouches": "integer",
"unconverted": "integer",
"currency?": "string | null",
"isTruncated": "boolean"
}A parameter is invalid, or the model does not apply to the outcome
Attribution is not in the plan
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/attribution" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/attribution', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/attribution'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/attribution",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a campaign's report
One campaign's numbers over its own dates, or from and to: sessions and visitors on its key, new contacts (first touch in the campaign) and influenced contacts (any touch in it), deals and revenue credited by the model (linear unless named), spend, cost per contact, return on spend and progress toward its goals. Each asset comes with its name, when it was sent, published or starts, its own numbers, and the new contacts and revenue credited to it when it is an email, a form, a CTA or a tracking URL.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| campaignId required | path | string | The campaign |
| model | query | string | The model deals and revenue are credited by; linear when left out |
| from | query | string | The start of the window, an RFC 3339 instant; the campaign's start date when left out |
| to | query | string | The end of the window, an RFC 3339 instant; the day after the campaign's end date when left out |
| lookbackDays | query | integer | Days of touches before each outcome, 1 to 365; 90 when left out |
Responses
The report
{
"campaignId": "string",
"model": "string",
"from": "string",
"to": "string",
"sessions": "integer",
"visitors": "integer",
"newContacts": "number",
"influencedContacts": "integer",
"deals?": "number | null",
"revenue": "number",
"currency": "string",
"spent": "string",
"costPerContact?": "number | null",
"returnOnSpend?": "number | null",
"contactsGoalProgress?": "number | null",
"dealsGoalProgress?": "number | null",
"revenueGoalProgress?": "number | null",
"unconvertedRevenue": "integer",
"isTruncated": "boolean",
"assets": [
{
"kind": "string",
"assetId": "string",
"name?": "string | null",
"momentKind?": "string | null",
"momentAt?": "string | null",
"numbers?": {
"sent?": "integer | null",
"delivered?": "integer | null",
"opened?": "integer | null",
"clicked?": "integer | null",
"views?": "integer | null",
"clicks?": "integer | null",
"submissions?": "integer | null",
"enrolled?": "integer | null",
"goalMet?": "integer | null",
"goalRate?": "number | null",
"registered?": "integer | null",
"attended?": "integer | null",
"sessions?": "integer | null"
},
"newContacts?": "number | null",
"revenue?": "number | null"
}
]
}A parameter is invalid, or the campaign has no dates and none were given
No such campaign
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/report" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/report', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/report'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/campaigns/:campaignId/report",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read every campaign's numbers
New contacts (first touch in the campaign) and revenue credited by the linear model for every campaign that is not archived, each counted within that campaign's own dates, an open-ended one up to now. A campaign with no start date, or one yet to start, carries no numbers.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
The numbers
{
"campaigns": [
{
"campaignId": "string",
"newContacts?": "number | null",
"revenue?": "number | null"
}
],
"isTruncated": "boolean"
}Campaigns are not in the plan
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/campaign-numbers" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/campaign-numbers', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/campaign-numbers'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/campaign-numbers",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Run a journey
The people who pass through two to fifteen ordered stages in a range, the conversion from the stage before and from the first, and the median and 90th-percentile seconds between stages. The body is the journey: stages (each a kind of event with optional filters, lifecycle_stage with a stage, form_submitted with a formId, campaign_touched with a campaignId or with none for any campaign, deal_created, or deal_stage with a stageId), dateRange (from and to, RFC 3339 instants) and an optional breakdown by the first touch's channel, source or campaign. A stage counts for the person, so an anonymous visit and the identified visit after it are one journey.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The journey
{
"stages": [
{
"stage": "integer",
"people": "integer",
"conversionFromPrevious": "number",
"conversionFromFirst": "number",
"medianSeconds?": "integer | null",
"p90Seconds?": "integer | null"
}
],
"segments": [
{
"value": "string",
"campaignId?": "string | null",
"campaignName?": "string | null",
"stages": [
{
"stage": "integer",
"people": "integer",
"conversionFromPrevious": "number",
"conversionFromFirst": "number",
"medianSeconds?": "integer | null",
"p90Seconds?": "integer | null"
}
]
}
]
}The journey is malformed, names a stage the project does not have, or holds fewer than two or more than fifteen stages
Journey reports are not in the plan
A filter names a sensitive property the caller may not see
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/journeys/report" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/journeys/report', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/journeys/report'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/journeys/report",
headers={"Authorization": f"Bearer {bearer_auth}"},
)marketing-events
List marketing events
A project's webinars, conferences and in-person events, latest start first, each with the people who registered and attended and the campaign that groups it. Cancelled events are left out unless includeCancelled is true.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the marketing events belong to |
| includeCancelled | query | boolean | Whether cancelled events are listed too |
Responses
200 The marketing events
{
"marketingEvents": [
{
"id": "string",
"name": "string",
"kind": "string",
"startsAt": "string",
"endsAt": "string",
"timeZone": "string",
"url?": "string | null",
"organiser?": "string | null",
"description": "string",
"source": "string",
"connectionId?": "string | null",
"cancelledAt?": "string | null",
"campaignId?": "string | null",
"campaignName?": "string | null",
"registered?": "integer | null",
"attended?": "integer | null",
"cancelled?": "integer | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/marketing-events" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-events', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-events'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/marketing-events",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a marketing event
Creates an event by hand, with its start and end as RFC 3339 timestamps and the IANA time zone they are shown in.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the marketing events belong to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"kind": "string",
"startsAt": "string",
"endsAt": "string",
"timeZone": "string",
"url?": "string | null",
"organiser?": "string | null",
"description?": "string"
}Responses
The marketing event
{
"id": "string",
"name": "string",
"kind": "string",
"startsAt": "string",
"endsAt": "string",
"timeZone": "string",
"url?": "string | null",
"organiser?": "string | null",
"description": "string",
"source": "string",
"connectionId?": "string | null",
"cancelledAt?": "string | null",
"campaignId?": "string | null",
"campaignName?": "string | null",
"registered?": "integer | null",
"attended?": "integer | null",
"cancelled?": "integer | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}A field is invalid
Marketing events are not in the plan
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-events" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","kind":"string","startsAt":"string","endsAt":"string","timeZone":"string","url":"string","organiser":"string","description":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-events', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"kind": "string",
"startsAt": "string",
"endsAt": "string",
"timeZone": "string",
"url": "string",
"organiser": "string",
"description": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-events'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","kind":"string","startsAt":"string","endsAt":"string","timeZone":"string","url":"string","organiser":"string","description":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-events",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","kind":"string","startsAt":"string","endsAt":"string","timeZone":"string","url":"string","organiser":"string","description":"string"},
)Read a marketing event
An event with the people who registered and attended and the campaign that groups it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the marketing events belong to |
| marketingEventId required | path | string | The marketing event |
Responses
The marketing event
{
"id": "string",
"name": "string",
"kind": "string",
"startsAt": "string",
"endsAt": "string",
"timeZone": "string",
"url?": "string | null",
"organiser?": "string | null",
"description": "string",
"source": "string",
"connectionId?": "string | null",
"cancelledAt?": "string | null",
"campaignId?": "string | null",
"campaignName?": "string | null",
"registered?": "integer | null",
"attended?": "integer | null",
"cancelled?": "integer | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such marketing event
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Update a marketing event
Replaces an event's name, kind, times, time zone, address, organiser and description. An event synced from a provider is changed there and refused here.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the marketing events belong to |
| marketingEventId required | path | string | The marketing event |
Body
{
"name": "string",
"kind": "string",
"startsAt": "string",
"endsAt": "string",
"timeZone": "string",
"url?": "string | null",
"organiser?": "string | null",
"description?": "string"
}Responses
The marketing event
{
"id": "string",
"name": "string",
"kind": "string",
"startsAt": "string",
"endsAt": "string",
"timeZone": "string",
"url?": "string | null",
"organiser?": "string | null",
"description": "string",
"source": "string",
"connectionId?": "string | null",
"cancelledAt?": "string | null",
"campaignId?": "string | null",
"campaignName?": "string | null",
"registered?": "integer | null",
"attended?": "integer | null",
"cancelled?": "integer | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}A field is invalid
No such marketing event
The event is synced from a provider
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","kind":"string","startsAt":"string","endsAt":"string","timeZone":"string","url":"string","organiser":"string","description":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"kind": "string",
"startsAt": "string",
"endsAt": "string",
"timeZone": "string",
"url": "string",
"organiser": "string",
"description": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","kind":"string","startsAt":"string","endsAt":"string","timeZone":"string","url":"string","organiser":"string","description":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","kind":"string","startsAt":"string","endsAt":"string","timeZone":"string","url":"string","organiser":"string","description":"string"},
)Delete a marketing event
Deletes an event and takes it out of the campaign that grouped it. The person events already recorded stay on each person's timeline.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the marketing events belong to |
| marketingEventId required | path | string | The marketing event |
Responses
Deleted
No such marketing event
The event is synced from a provider
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List a marketing event's people
One page of the people on an event, earliest registration first, each with their status, the times they registered, attended and cancelled, the minutes they stayed and the name People holds for them. A person who came reads attended; otherwise cancelled when their latest cancellation is not followed by a registration; otherwise registered.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the marketing events belong to |
| marketingEventId required | path | string | The marketing event |
| status | query | string | Only people with this status: registered, attended or cancelled |
| limit | query | integer | How many people a page holds, 1 to 500; 100 when left out |
| offset | query | integer | How many people to skip before the page starts |
Responses
The people
{
"people": [
{
"email": "string",
"name?": "string | null",
"status": "string",
"registeredAt?": "string | null",
"attendedAt?": "string | null",
"cancelledAt?": "string | null",
"attendedMinutes?": "integer | null"
}
],
"total": "integer"
}The status is not one of the three
No such marketing event
The analytics store is not reachable
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/people" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/people', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/people'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/people",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Cancel a marketing event
Takes an event out of the list; its registrations and attendance stay.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the marketing events belong to |
| marketingEventId required | path | string | The marketing event |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The marketing event
{
"id": "string",
"name": "string",
"kind": "string",
"startsAt": "string",
"endsAt": "string",
"timeZone": "string",
"url?": "string | null",
"organiser?": "string | null",
"description": "string",
"source": "string",
"connectionId?": "string | null",
"cancelledAt?": "string | null",
"campaignId?": "string | null",
"campaignName?": "string | null",
"registered?": "integer | null",
"attended?": "integer | null",
"cancelled?": "integer | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such marketing event
The event is synced from a provider
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/cancel" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/cancel', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/cancel'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/cancel",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Restore a marketing event
Brings a cancelled event back into the list.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the marketing events belong to |
| marketingEventId required | path | string | The marketing event |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The marketing event
{
"id": "string",
"name": "string",
"kind": "string",
"startsAt": "string",
"endsAt": "string",
"timeZone": "string",
"url?": "string | null",
"organiser?": "string | null",
"description": "string",
"source": "string",
"connectionId?": "string | null",
"cancelledAt?": "string | null",
"campaignId?": "string | null",
"campaignName?": "string | null",
"registered?": "integer | null",
"attended?": "integer | null",
"cancelled?": "integer | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such marketing event
The event is synced from a provider
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/restore" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/restore', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/restore'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/restore",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Record a registration
Records that a person registered, as the person event $marketing_event_registered on their email address, which also sets their email and name.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the marketing events belong to |
| marketingEventId required | path | string | The marketing event |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"email": "string",
"name?": "string | null",
"at?": "string | null"
}Responses
Recorded
The email, name, minutes or time is invalid
Marketing events are not in the plan
No such marketing event
The event is cancelled
The event stream is not reachable
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/registrations" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"email":"string","name":"string","at":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/registrations', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"email": "string",
"name": "string",
"at": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/registrations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"email":"string","name":"string","at":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/registrations",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"email":"string","name":"string","at":"string"},
)Record an attendance
Records that a person attended, as the person event $marketing_event_attended on their email address, with the minutes they stayed when known.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the marketing events belong to |
| marketingEventId required | path | string | The marketing event |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"email": "string",
"attendedMinutes?": "integer | null",
"at?": "string | null"
}Responses
Recorded
The email, name, minutes or time is invalid
Marketing events are not in the plan
No such marketing event
The event is cancelled
The event stream is not reachable
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/attendance" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"email":"string","attendedMinutes":0,"at":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/attendance', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"email": "string",
"attendedMinutes": 0,
"at": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/attendance'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"email":"string","attendedMinutes":0,"at":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/attendance",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"email":"string","attendedMinutes":0,"at":"string"},
)Record a cancelled registration
Records that a person cancelled their registration, as the person event $marketing_event_cancelled on their email address.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the marketing events belong to |
| marketingEventId required | path | string | The marketing event |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"email": "string",
"at?": "string | null"
}Responses
Recorded
The email, name, minutes or time is invalid
Marketing events are not in the plan
No such marketing event
The event is cancelled
The event stream is not reachable
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/cancellations" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"email":"string","at":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/cancellations', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"email": "string",
"at": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/cancellations'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"email":"string","at":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-events/:marketingEventId/cancellations",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"email":"string","at":"string"},
)integrations
List integration providers
Every tool this build can connect, with the mechanisms each supports and the kind of target it takes.
Responses
The providers
{
"providers": [
{
"key": "string",
"displayName": "string",
"mechanisms": [],
"targetModel": "string"
}
]
}The caller may not take this action
Try it
curl -X GET "https://api.prodantix.com/v1/integrations/providers" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/integrations/providers', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/integrations/providers'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/integrations/providers",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List a project's connections
The connections a project may name: its own first, then the organisation's that reach it, a page at a time. A target carries a hint, never its secret.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| limit | query | integer | At most this many connections, 500 at most |
| after | query | string | The last connection id of the page before |
Responses
The connections
{
"connections": [
{
"id": "string",
"provider": "string",
"mechanism": "string",
"name": "string",
"status": "string",
"testMode": "string",
"scope": "string",
"reach?": "string | null",
"hasSigningSecret": "boolean",
"hasBodyTemplate": "boolean",
"hasWorkspace": "boolean",
"lastAttemptedAt?": "string | null",
"lastDeliveredAt?": "string | null",
"targets": [
{
"id": "string",
"name": "string",
"environment": "string",
"hint": "string"
}
],
"eventCount?": "integer | null",
"lastPulledAt?": "string | null",
"needsReauthorization": "boolean",
"channelsPostedTo?": "integer | null"
}
]
}The caller may not take this action
No such project
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/integrations/connections" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/integrations/connections', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/integrations/connections'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/integrations/connections",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Connect a tool
A project connection names its project and takes no reach; an organisation connection names none and takes enforced, opt_in or subset.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"provider": "string",
"mechanism": "string",
"name": "string",
"projectId?": "string | null",
"reach?": "string | null",
"testMode": "string"
}Responses
The new connection's id
{
"id": "string"
}The scope, reach or test mode breaks a rule
The caller may not take this action
Try it
curl -X POST "https://api.prodantix.com/v1/integrations/connections" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"provider":"string","mechanism":"string","name":"string","projectId":"string","reach":"string","testMode":"string"}'const response = await fetch('https://api.prodantix.com/v1/integrations/connections', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"provider": "string",
"mechanism": "string",
"name": "string",
"projectId": "string",
"reach": "string",
"testMode": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/integrations/connections'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"provider":"string","mechanism":"string","name":"string","projectId":"string","reach":"string","testMode":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/integrations/connections",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"provider":"string","mechanism":"string","name":"string","projectId":"string","reach":"string","testMode":"string"},
)Revoke a connection
Withdraws a connection for good; its secrets and targets go with it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| connectionId required | path | string | The connection |
Responses
Whether anything changed
{
"changed": "boolean"
}The request breaks a rule
The caller may not take this action
Try it
curl -X DELETE "https://api.prodantix.com/v1/integrations/connections/:connectionId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/integrations/connections/:connectionId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/integrations/connections/:connectionId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/integrations/connections/:connectionId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add a target
Adds a destination to a connection. The secret is sealed and never readable again.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| connectionId required | path | string | The connection |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"environment": "string",
"secret": "string"
}Responses
The new target's id
{
"id": "string"
}The caller may not take this action
This deploy cannot seal secrets
Try it
curl -X POST "https://api.prodantix.com/v1/integrations/connections/:connectionId/targets" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","environment":"string","secret":"string"}'const response = await fetch('https://api.prodantix.com/v1/integrations/connections/:connectionId/targets', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"environment": "string",
"secret": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/integrations/connections/:connectionId/targets'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","environment":"string","secret":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/integrations/connections/:connectionId/targets",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","environment":"string","secret":"string"},
)Set a connection's test mode
What a test run does: send for real, send to test targets, or log only.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| connectionId required | path | string | The connection |
Body
{
"testMode": "string"
}Responses
Whether anything changed
{
"changed": "boolean"
}The request breaks a rule
The caller may not take this action
Try it
curl -X PUT "https://api.prodantix.com/v1/integrations/connections/:connectionId/test-mode" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"testMode":"string"}'const response = await fetch('https://api.prodantix.com/v1/integrations/connections/:connectionId/test-mode', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"testMode": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/integrations/connections/:connectionId/test-mode'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"testMode":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/integrations/connections/:connectionId/test-mode",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"testMode":"string"},
)Set an organisation connection's reach
How far an organisation connection reaches: every project, the ones that opt in, or a named subset.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| connectionId required | path | string | The connection |
Body
{
"reach": "string"
}Responses
Whether anything changed
{
"changed": "boolean"
}The request breaks a rule
The caller may not take this action
Try it
curl -X PUT "https://api.prodantix.com/v1/integrations/connections/:connectionId/reach" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"reach":"string"}'const response = await fetch('https://api.prodantix.com/v1/integrations/connections/:connectionId/reach', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"reach": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/integrations/connections/:connectionId/reach'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"reach":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/integrations/connections/:connectionId/reach",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"reach":"string"},
)Name a project an organisation connection serves
Joins or leaves a project for an opt_in or subset connection.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| connectionId required | path | string | The connection |
Body
{
"enabled": "boolean"
}Responses
Whether anything changed
{
"changed": "boolean"
}The request breaks a rule
The caller may not take this action
Try it
curl -X PUT "https://api.prodantix.com/v1/integrations/connections/:connectionId/projects/:projectId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"enabled":true}'const response = await fetch('https://api.prodantix.com/v1/integrations/connections/:connectionId/projects/:projectId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"enabled": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/integrations/connections/:connectionId/projects/:projectId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"enabled":true}),
);response = requests.put(
"https://api.prodantix.com/v1/integrations/connections/:connectionId/projects/:projectId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"enabled":true},
)Set a connection's fixed body
Sets or clears the fixed body a connection sends, at most 10,000 characters.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| connectionId required | path | string | The connection |
Body
{
"bodyTemplate?": "string | null"
}Responses
Whether anything changed
{
"changed": "boolean"
}The request breaks a rule
The caller may not take this action
Try it
curl -X PUT "https://api.prodantix.com/v1/integrations/connections/:connectionId/body-template" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"bodyTemplate":"string"}'const response = await fetch('https://api.prodantix.com/v1/integrations/connections/:connectionId/body-template', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"bodyTemplate": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/integrations/connections/:connectionId/body-template'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"bodyTemplate":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/integrations/connections/:connectionId/body-template",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"bodyTemplate":"string"},
)Pause or resume a connection
Switches a connection off without losing it, or back on.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| connectionId required | path | string | The connection |
Body
{
"disabled": "boolean"
}Responses
Whether anything changed
{
"changed": "boolean"
}The request breaks a rule
The caller may not take this action
Try it
curl -X PUT "https://api.prodantix.com/v1/integrations/connections/:connectionId/disabled" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"disabled":true}'const response = await fetch('https://api.prodantix.com/v1/integrations/connections/:connectionId/disabled', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"disabled": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/integrations/connections/:connectionId/disabled'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"disabled":true}),
);response = requests.put(
"https://api.prodantix.com/v1/integrations/connections/:connectionId/disabled",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"disabled":true},
)List an installed workspace's channels
The channels a Slack connection's workspace can post to, read live from Slack.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| connectionId required | path | string | The connection |
Responses
The channels
{
"channels": [
{
"id": "string",
"name": "string"
}
]
}The caller may not take this action
No such connection
Slack did not list the channels
Try it
curl -X GET "https://api.prodantix.com/v1/integrations/connections/:connectionId/slack-channels" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/integrations/connections/:connectionId/slack-channels', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/integrations/connections/:connectionId/slack-channels'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/integrations/connections/:connectionId/slack-channels",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Start a Slack install
Answers the page where a person installs the Slack app for this connection, with a signed, expiring state.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| connectionId required | path | string | The connection |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
Where the browser goes
{
"url": "string"
}The caller may not take this action
No such connection
This deploy has no Slack app
Try it
curl -X POST "https://api.prodantix.com/v1/integrations/connections/:connectionId/slack-install" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/integrations/connections/:connectionId/slack-install', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/integrations/connections/:connectionId/slack-install'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/integrations/connections/:connectionId/slack-install",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Finish a Slack install
Proves the state, trades the code Slack returned for a workspace token and seals it onto the connection.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"code": "string",
"state": "string"
}Responses
Whether anything changed
{
"changed": "boolean"
}The request breaks a rule
The caller may not take this action
Try it
curl -X POST "https://api.prodantix.com/v1/integrations/slack-install/complete" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"code":"string","state":"string"}'const response = await fetch('https://api.prodantix.com/v1/integrations/slack-install/complete', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"code": "string",
"state": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/integrations/slack-install/complete'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"code":"string","state":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/integrations/slack-install/complete",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"code":"string","state":"string"},
)Start an event platform sign-in
Answers the page where a person signs a project's Zoom, GoTo Webinar or Eventbrite account in.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| connectionId required | path | string | The connection |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
Where the browser goes
{
"url": "string"
}Event connectors are not in the plan
The caller may not take this action
No such connection
This deploy has no application for the platform
Try it
curl -X POST "https://api.prodantix.com/v1/integrations/connections/:connectionId/event-connector-install" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/integrations/connections/:connectionId/event-connector-install', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/integrations/connections/:connectionId/event-connector-install'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/integrations/connections/:connectionId/event-connector-install",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Finish an event platform sign-in
Proves the state, trades the code the platform returned for tokens and stores them sealed against the connection.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"provider": "string",
"code": "string",
"state": "string"
}Responses
Whether anything changed
{
"changed": "boolean"
}The request breaks a rule
The caller may not take this action
Try it
curl -X POST "https://api.prodantix.com/v1/integrations/event-connector-install/complete" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"provider":"string","code":"string","state":"string"}'const response = await fetch('https://api.prodantix.com/v1/integrations/event-connector-install/complete', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"provider": "string",
"code": "string",
"state": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/integrations/event-connector-install/complete'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"provider":"string","code":"string","state":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/integrations/event-connector-install/complete",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"provider":"string","code":"string","state":"string"},
)Cancel an event platform sign-in
Withdraws the connection a cancelled sign-in left behind, when the caller created it; one that already holds an account is kept.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"provider": "string",
"state": "string"
}Responses
Whether anything changed
{
"changed": "boolean"
}The request breaks a rule
The caller may not take this action
Try it
curl -X POST "https://api.prodantix.com/v1/integrations/event-connector-install/cancel" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"provider":"string","state":"string"}'const response = await fetch('https://api.prodantix.com/v1/integrations/event-connector-install/cancel', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"provider": "string",
"state": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/integrations/event-connector-install/cancel'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"provider":"string","state":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/integrations/event-connector-install/cancel",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"provider":"string","state":"string"},
)Pull an event platform now
Pulls a connected account's events and people now rather than at the next scheduled pass.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| connectionId required | path | string | The connection |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
What the pull brought in
{
"events": "integer",
"writes": "integer"
}The connection cannot pull
Event connectors are not in the plan
The caller may not take this action
A pull of this connection is already running
The platform did not answer
Try it
curl -X POST "https://api.prodantix.com/v1/integrations/connections/:connectionId/pull" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/integrations/connections/:connectionId/pull', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/integrations/connections/:connectionId/pull'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/integrations/connections/:connectionId/pull",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Send a test
Sends one message through a connection now and reports what the tool said.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| connectionId required | path | string | The connection |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"targetId?": "string | null",
"channel?": {
"id": "string",
"name": "string"
},
"emailTo?": "string | null"
}Responses
What the send did
{
"delivered": "boolean",
"loggedOnly": "boolean",
"refusal?": "string | null",
"targetName": "string"
}The recipient or connection breaks a rule
The caller may not take this action
No active connection with that id
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/integrations/connections/:connectionId/test" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"targetId":"string","channel":"string","emailTo":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/integrations/connections/:connectionId/test', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"targetId": "string",
"channel": "string",
"emailTo": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/integrations/connections/:connectionId/test'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"targetId":"string","channel":"string","emailTo":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/integrations/connections/:connectionId/test",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"targetId":"string","channel":"string","emailTo":"string"},
)List sending domains
The company's sending domains, each with the DNS records to add (DKIM, SPF, tracking and DMARC) and its status. Needs prodantix.email.read.
Responses
200 The domains
{
"domains": [
{
"id": "string",
"name": "string",
"status": "string",
"records": [
{
"purpose": "string",
"recordType": "string",
"name": "string",
"value": "string",
"priority?": "integer | null",
"status": "string"
}
],
"trackingSubdomain": "string",
"openTracking": "boolean",
"clickTracking": "boolean",
"dmarcSeen": "boolean",
"dedicatedPool": "string",
"lastError?": "string | null",
"checkedAt?": "string | null",
"verifiedAt?": "string | null",
"createdAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/company/email/domains" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/email/domains', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/company/email/domains'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/company/email/domains",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add a sending domain
Creates the domain at the email provider in the EU region with a tracking subdomain, and answers the records to add. One company holds a domain; an unverified one is released after 72 hours. Counted against the plan's max_sending_domains. Needs prodantix.email.manage and marketing_email on the plan.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string"
}Responses
The domain
{
"id": "string",
"name": "string",
"status": "string",
"records": [
{
"purpose": "string",
"recordType": "string",
"name": "string",
"value": "string",
"priority?": "integer | null",
"status": "string"
}
],
"trackingSubdomain": "string",
"openTracking": "boolean",
"clickTracking": "boolean",
"dmarcSeen": "boolean",
"dedicatedPool": "string",
"lastError?": "string | null",
"checkedAt?": "string | null",
"verifiedAt?": "string | null",
"createdAt": "string"
}The domain is refused
The plan does not send marketing email, or holds no more domains
Another company holds the domain
Try it
curl -X POST "https://api.prodantix.com/v1/company/email/domains" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'const response = await fetch('https://api.prodantix.com/v1/company/email/domains', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/company/email/domains'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/company/email/domains",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string"},
)Check a sending domain now
Asks the provider to verify the domain's records and looks up its DMARC record, rather than waiting for the ten-minute pass. Needs prodantix.email.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| domainId required | path | string | The sending domain |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The domain
{
"id": "string",
"name": "string",
"status": "string",
"records": [
{
"purpose": "string",
"recordType": "string",
"name": "string",
"value": "string",
"priority?": "integer | null",
"status": "string"
}
],
"trackingSubdomain": "string",
"openTracking": "boolean",
"clickTracking": "boolean",
"dmarcSeen": "boolean",
"dedicatedPool": "string",
"lastError?": "string | null",
"checkedAt?": "string | null",
"verifiedAt?": "string | null",
"createdAt": "string"
}No such record
Try it
curl -X POST "https://api.prodantix.com/v1/company/email/domains/:domainId/check" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/email/domains/:domainId/check', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/company/email/domains/:domainId/check'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/company/email/domains/:domainId/check",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Set a domain's tracking
The tracking subdomain (one label, such as links) and whether opens and clicks are tracked. Needs prodantix.email.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| domainId required | path | string | The sending domain |
Body
{
"subdomain": "string",
"openTracking": "boolean",
"clickTracking": "boolean"
}Responses
The domain
{
"id": "string",
"name": "string",
"status": "string",
"records": [
{
"purpose": "string",
"recordType": "string",
"name": "string",
"value": "string",
"priority?": "integer | null",
"status": "string"
}
],
"trackingSubdomain": "string",
"openTracking": "boolean",
"clickTracking": "boolean",
"dmarcSeen": "boolean",
"dedicatedPool": "string",
"lastError?": "string | null",
"checkedAt?": "string | null",
"verifiedAt?": "string | null",
"createdAt": "string"
}The subdomain is refused
No such record
Try it
curl -X PUT "https://api.prodantix.com/v1/company/email/domains/:domainId/tracking" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"subdomain":"string","openTracking":true,"clickTracking":true}'const response = await fetch('https://api.prodantix.com/v1/company/email/domains/:domainId/tracking', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"subdomain": "string",
"openTracking": true,
"clickTracking": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/company/email/domains/:domainId/tracking'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"subdomain":"string","openTracking":true,"clickTracking":true}),
);response = requests.put(
"https://api.prodantix.com/v1/company/email/domains/:domainId/tracking",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"subdomain":"string","openTracking":true,"clickTracking":true},
)Remove a sending domain
Removes the domain at the provider and releases it; mail stops leaving from it. Needs prodantix.email.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| domainId required | path | string | The sending domain |
Responses
The domain
{
"id": "string",
"name": "string",
"status": "string",
"records": [
{
"purpose": "string",
"recordType": "string",
"name": "string",
"value": "string",
"priority?": "integer | null",
"status": "string"
}
],
"trackingSubdomain": "string",
"openTracking": "boolean",
"clickTracking": "boolean",
"dmarcSeen": "boolean",
"dedicatedPool": "string",
"lastError?": "string | null",
"checkedAt?": "string | null",
"verifiedAt?": "string | null",
"createdAt": "string"
}No such record
Try it
curl -X DELETE "https://api.prodantix.com/v1/company/email/domains/:domainId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/email/domains/:domainId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/company/email/domains/:domainId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/company/email/domains/:domainId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Request a dedicated IP pool
Asks for a dedicated IP pool on a verified domain; staff provision it and the domain shows requested, warming, then active. Needs prodantix.email.manage and email_dedicated_ip on the plan.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| domainId required | path | string | The sending domain |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The domain
{
"id": "string",
"name": "string",
"status": "string",
"records": [
{
"purpose": "string",
"recordType": "string",
"name": "string",
"value": "string",
"priority?": "integer | null",
"status": "string"
}
],
"trackingSubdomain": "string",
"openTracking": "boolean",
"clickTracking": "boolean",
"dmarcSeen": "boolean",
"dedicatedPool": "string",
"lastError?": "string | null",
"checkedAt?": "string | null",
"verifiedAt?": "string | null",
"createdAt": "string"
}The plan has no dedicated IP
No such record
The domain is not verified yet
Try it
curl -X POST "https://api.prodantix.com/v1/company/email/domains/:domainId/dedicated-ip" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/email/domains/:domainId/dedicated-ip', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/company/email/domains/:domainId/dedicated-ip'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/company/email/domains/:domainId/dedicated-ip",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the company's email settings
The postal address every marketing message carries and the DMARC report address. Needs prodantix.email.read.
Responses
200 The settings
{
"postalAddress": "string",
"dmarcReports": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/company/email/settings" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/email/settings', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/company/email/settings'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/company/email/settings",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Save the company's email settings
The postal address (required before the first marketing send, at most 500 characters) and the DMARC report address. Needs prodantix.email.manage.
Body
{
"postalAddress": "string",
"dmarcReports": "string"
}Responses
The settings
{
"postalAddress": "string",
"dmarcReports": "string"
}A value is refused
Try it
curl -X PUT "https://api.prodantix.com/v1/company/email/settings" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"postalAddress":"string","dmarcReports":"string"}'const response = await fetch('https://api.prodantix.com/v1/company/email/settings', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"postalAddress": "string",
"dmarcReports": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/company/email/settings'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"postalAddress":"string","dmarcReports":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/company/email/settings",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"postalAddress":"string","dmarcReports":"string"},
)List subscription types
The project's subscription types with their texts per language, channel, purpose and double opt-in; a project starts with Marketing information and Service messages. Needs prodantix.email.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
200 The types
{
"types": [
{
"id": "string",
"key": "string",
"texts": "unknown",
"channel": "string",
"purpose": "string",
"doubleOptIn": "boolean",
"archived": "boolean",
"updatedAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/email/subscription-types" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/subscription-types', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/subscription-types'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/email/subscription-types",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add a subscription type
A key, the name and description per language (English required), the channel (email, sms or push), the purpose (marketing or service) and double opt-in. Needs prodantix.email.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"key": "string",
"texts": "unknown",
"channel?": "string | null",
"purpose?": "string | null",
"doubleOptIn?": "boolean | null"
}Responses
The type
{
"id": "string",
"key": "string",
"texts": "unknown",
"channel": "string",
"purpose": "string",
"doubleOptIn": "boolean",
"archived": "boolean",
"updatedAt": "string"
}The type is refused
The key is taken
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/email/subscription-types" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"key":"string","texts":"string","channel":"string","purpose":"string","doubleOptIn":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/subscription-types', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"key": "string",
"texts": "string",
"channel": "string",
"purpose": "string",
"doubleOptIn": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/subscription-types'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"key":"string","texts":"string","channel":"string","purpose":"string","doubleOptIn":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/email/subscription-types",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"key":"string","texts":"string","channel":"string","purpose":"string","doubleOptIn":true},
)Change a subscription type
Its texts and double opt-in; the key, channel and purpose stay what people agreed to. Needs prodantix.email.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| typeId required | path | string | The subscription type |
Body
{
"texts": "unknown",
"doubleOptIn": "boolean"
}Responses
The type
{
"id": "string",
"key": "string",
"texts": "unknown",
"channel": "string",
"purpose": "string",
"doubleOptIn": "boolean",
"archived": "boolean",
"updatedAt": "string"
}No such record
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/email/subscription-types/:typeId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"texts":"string","doubleOptIn":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/subscription-types/:typeId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"texts": "string",
"doubleOptIn": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/subscription-types/:typeId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"texts":"string","doubleOptIn":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/email/subscription-types/:typeId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"texts":"string","doubleOptIn":true},
)Archive or restore a subscription type
An archived type leaves the preferences page and sends nothing; its people's answers stay. Needs prodantix.email.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| typeId required | path | string | The subscription type |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"archived": "boolean"
}Responses
The type
{
"id": "string",
"key": "string",
"texts": "unknown",
"channel": "string",
"purpose": "string",
"doubleOptIn": "boolean",
"archived": "boolean",
"updatedAt": "string"
}No such record
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/email/subscription-types/:typeId/archive" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"archived":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/subscription-types/:typeId/archive', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"archived": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/subscription-types/:typeId/archive'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"archived":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/email/subscription-types/:typeId/archive",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"archived":true},
)List suppressed addresses
The project's suppressions, the newest first, with why (hard_bounce, soft_bounce, complaint, provider, invalid, manual). Needs prodantix.email.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| search | query | string | The start of an address |
| limit | query | string | At most 200; 50 when left out |
| offset | query | string | How many to skip |
Responses
200 The suppressions
{
"suppressions": [
{
"id": "string",
"address": "string",
"distinctId?": "string | null",
"reason": "string",
"createdBy": "string",
"createdAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/email/suppressions" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/suppressions', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/suppressions'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/email/suppressions",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Suppress an address
Nothing is sent to a suppressed address. An address already suppressed keeps its first reason and answers null. Needs prodantix.users.write.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"address": "string"
}Responses
The suppression
{
"suppression?": {
"id": "string",
"address": "string",
"distinctId?": "string | null",
"reason": "string",
"createdBy": "string",
"createdAt": "string"
}
}The address is refused
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/email/suppressions" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"address":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/suppressions', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"address": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/suppressions'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"address":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/email/suppressions",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"address":"string"},
)Lift a suppression
Needs prodantix.users.write; one a bounce or complaint set also needs prodantix.email.manage, and the removal is audited.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| suppressionId required | path | string | The suppression |
Responses
The lifted suppression
{
"id": "string",
"address": "string",
"distinctId?": "string | null",
"reason": "string",
"createdBy": "string",
"createdAt": "string"
}A bounce or complaint suppression needs prodantix.email.manage
No such record
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/email/suppressions/:suppressionId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/suppressions/:suppressionId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/suppressions/:suppressionId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/email/suppressions/:suppressionId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read sending health
Sent, delivered, hard and soft bounces, complaints, opens, clicks and unsubscribes per day and domain, the 0.1% and 0.3% complaint marks, and whether marketing sending is paused. Needs prodantix.email.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| from required | query | string | The first day, YYYY-MM-DD |
| to required | query | string | The last day, YYYY-MM-DD |
Responses
The health
{
"days": [
{
"day": "string",
"domain": "string",
"sent": "integer",
"delivered": "integer",
"hardBounced": "integer",
"softBounced": "integer",
"complained": "integer",
"opened": "integer",
"clicked": "integer",
"unsubscribed": "integer"
}
],
"pausedAt?": "string | null",
"pausedReason?": "string | null",
"complaintMarks": []
}A date is refused
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/email/health" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/health', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/health'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/email/health",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Resume marketing sending
Marketing sending pauses past 0.3% complaints or 5% hard bounces over the last 1,000 sends; a member who reviewed the list resumes it. Needs prodantix.email.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
200 Whether it was paused
{
"resumed": "boolean"
}Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/email/resume" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/resume', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/resume'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/email/resume",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a person's subscriptions
Each subscription type's status for the person, the history of changes and whether they are a marketing contact. Needs prodantix.users.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| distinctId required | path | string | The person |
Responses
200 The person's subscriptions
{
"isMarketingContact": "boolean",
"subscriptions": [
{
"typeId": "string",
"distinctId": "string",
"status": "string",
"source": "string",
"legalBasis": "string",
"changedAt": "string"
}
],
"changes": [
{
"id": "string",
"typeId": "string",
"distinctId": "string",
"status": "string",
"source": "string",
"legalBasis": "string",
"actor": "string",
"createdAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/email-subscriptions" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/email-subscriptions', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/email-subscriptions'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/email-subscriptions",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Subscribe or unsubscribe a person
Names the legal basis (consent, legitimate_interest or contract); a type with double opt-in waits for the person's confirmation link. Each change is kept as a consent record. Needs prodantix.users.write.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| typeId required | path | string | The subscription type |
| distinctId required | path | string | The person |
Body
{
"subscribed": "boolean",
"legalBasis": "string"
}Responses
The person's subscriptions
{
"isMarketingContact": "boolean",
"subscriptions": [
{
"typeId": "string",
"distinctId": "string",
"status": "string",
"source": "string",
"legalBasis": "string",
"changedAt": "string"
}
],
"changes": [
{
"id": "string",
"typeId": "string",
"distinctId": "string",
"status": "string",
"source": "string",
"legalBasis": "string",
"actor": "string",
"createdAt": "string"
}
]
}The change is refused
No such record
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/email-subscriptions/:typeId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"subscribed":true,"legalBasis":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/email-subscriptions/:typeId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"subscribed": true,
"legalBasis": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/email-subscriptions/:typeId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"subscribed":true,"legalBasis":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/email-subscriptions/:typeId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"subscribed":true,"legalBasis":"string"},
)Set whether a person is a marketing contact
Only marketing contacts receive marketing email; the change is written on the person's timeline. Needs prodantix.users.write.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| distinctId required | path | string | The person |
Body
{
"isMarketingContact": "boolean"
}Responses
200 The person's subscriptions
{
"isMarketingContact": "boolean",
"subscriptions": [
{
"typeId": "string",
"distinctId": "string",
"status": "string",
"source": "string",
"legalBasis": "string",
"changedAt": "string"
}
],
"changes": [
{
"id": "string",
"typeId": "string",
"distinctId": "string",
"status": "string",
"source": "string",
"legalBasis": "string",
"actor": "string",
"createdAt": "string"
}
]
}Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/marketing-contact" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"isMarketingContact":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/marketing-contact', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"isMarketingContact": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/marketing-contact'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"isMarketingContact":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/people/:distinctId/marketing-contact",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"isMarketingContact":true},
)marketing-emails
List marketing emails
The project's marketing emails, the latest changed first. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
200 The emails
{
"emails": [
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/marketing-emails" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a marketing email
Creates a draft from a starter's key, a saved template's id, or blank. Needs prodantix.marketing_emails.manage and marketing_email on the plan.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"kind?": "string | null",
"template?": "string | null",
"language?": "string | null"
}Responses
The draft
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}The name, language or template is refused
The plan does not send marketing email
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-emails" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","kind":"string","template":"string","language":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"kind": "string",
"template": "string",
"language": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","kind":"string","template":"string","language":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","kind":"string","template":"string","language":"string"},
)Read a marketing email
The email with its versions, test, send time, cohorts and approval. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
Responses
The email
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such email
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Save a marketing email
Saves content and settings. A scheduled or awaiting email returns to draft and any approval clears, so what was approved is what is sent. HTML blocks need marketing_email_html_blocks on the plan. Needs prodantix.marketing_emails.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
Body
{
"name": "string",
"content": "unknown",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"test?": "unknown",
"send?": "unknown",
"recipients?": "unknown"
}Responses
The email
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}The content or a setting is refused
The plan has no HTML blocks
No such email
The email is not in a state that allows this
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","content":"string","fromDomain":"string","fromLocal":"string","fromName":"string","replyTo":"string","subscriptionTypeId":"string","language":"string","test":"string","send":"string","recipients":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"content": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId": "string",
"language": "string",
"test": "string",
"send": "string",
"recipients": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","content":"string","fromDomain":"string","fromLocal":"string","fromName":"string","replyTo":"string","subscriptionTypeId":"string","language":"string","test":"string","send":"string","recipients":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","content":"string","fromDomain":"string","fromLocal":"string","fromName":"string","replyTo":"string","subscriptionTypeId":"string","language":"string","test":"string","send":"string","recipients":"string"},
)Archive a marketing email
Archives a draft, an awaiting, a sent or a cancelled email; its report stays. Needs prodantix.marketing_emails.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
Responses
The email
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such email
The email is not in a state that allows this
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Check a marketing email before sending
Everything that stands between the email and its send: content, sending domain, from address, subscription type, cohorts, postal address, a paused project, the test, the send time, the plan and approval. Empty when it is ready. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
Responses
The problems
{
"problems": [
{
"code": "string",
"message": "string"
}
]
}No such email
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/readiness" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/readiness', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/readiness'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/readiness",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Preview a marketing email
One version as HTML and plain text, personalised as a person or with every fallback. Its footer links change no one's subscription. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
| variant | query | string | The version; the first when left out |
| distinctId | query | string | The person to personalise it as; every fallback when left out |
Responses
The preview
{
"subject": "string",
"previewText": "string",
"html": "string",
"text": "string"
}No such version
No such email
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/preview" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/preview', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/preview'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/preview",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a marketing email's report
Sent, delivered, opened, clicked, bounced, complained, unsubscribed and skipped per version, the test's winner, and the links clicked. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
Responses
The report
{
"recipientCount": "integer",
"winner?": "string | null",
"skipped": "unknown",
"variants": [
{
"variant": "string",
"queued": "integer",
"sent": "integer",
"delivered": "integer",
"opened": "integer",
"opens": "integer",
"clicked": "integer",
"clicks": "integer",
"bounced": "integer",
"complained": "integer",
"unsubscribed": "integer",
"skipped": "integer"
}
],
"links": [
{
"url": "string",
"people": "integer"
}
]
}No such email
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/report" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/report', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/report'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/report",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Send a test to yourself
Sends every version, or the one named, to the signed-in member's own address and no one else, the subject marked as a test. Needs prodantix.marketing_emails.manage and a verified sending domain.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"variant?": "string | null",
"distinctId?": "string | null"
}Responses
How many went
{
"sent": "integer"
}The sign-in carries no address, or no such version
No such email
The email names no verified sending domain
The email provider could not be reached
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/test" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"variant":"string","distinctId":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/test', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"variant": "string",
"distinctId": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/test'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"variant":"string","distinctId":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/test",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"variant":"string","distinctId":"string"},
)Ask for approval
Sends a draft for approval by someone other than its author. Needs prodantix.marketing_emails.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The email
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such email
The email is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/approval-request" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/approval-request', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/approval-request'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/approval-request",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Approve a marketing email
Approves an email awaiting approval; it returns to draft, approved, ready to schedule. The author cannot approve their own. Needs prodantix.marketing_emails.approve.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"note?": "string | null"
}Responses
The email
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}The author cannot approve their own email
No such email
The email is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/approve" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"note":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/approve', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"note": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/approve'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"note":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/approve",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"note":"string"},
)Send a marketing email back
Returns an email awaiting approval to draft with a note saying what to change. Needs prodantix.marketing_emails.approve.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"note?": "string | null"
}Responses
The email
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such email
The email is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/reject" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"note":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/reject', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"note": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/reject'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"note":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/reject",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"note":"string"},
)Schedule a marketing email
Schedules a ready draft for its send time. A refusal lists every problem in details.problems. Tests and send time optimisation need their plan features. Needs prodantix.marketing_emails.send.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The email
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}The plan does not send marketing email
No such email
The email is not ready, or not a draft
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/schedule" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/schedule', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/schedule'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/schedule",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Unschedule a marketing email
Takes a scheduled email back to draft. Needs prodantix.marketing_emails.send.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The email
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such email
The email is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/unschedule" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/unschedule', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/unschedule'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/unschedule",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Pause a marketing email
Holds a sending email's copies not yet sent. Needs prodantix.marketing_emails.send.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The email
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such email
The email is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/pause" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/pause', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/pause'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/pause",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Resume a marketing email
Sends a paused email's held copies. Needs prodantix.marketing_emails.send.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The email
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such email
The email is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/resume" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/resume', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/resume'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/resume",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Cancel a marketing email
Stops a scheduled, sending or paused email for good; copies not yet sent are skipped. Needs prodantix.marketing_emails.send.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| emailId required | path | string | The marketing email |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The email
{
"id": "string",
"projectId": "string",
"name": "string",
"kind": "string",
"status": "string",
"fromDomain": "string",
"fromLocal": "string",
"fromName": "string",
"replyTo": "string",
"subscriptionTypeId?": "string | null",
"language": "string",
"content": "unknown",
"test": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"sentVersion?": "integer | null",
"winner?": "string | null",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such email
The email is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/cancel" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/cancel', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/cancel'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/marketing-emails/:emailId/cancel",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Estimate a marketing email's audience
How many people are in the included cohorts and in none left out, before subscriptions, suppressions and the frequency cap narrow them. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| include | query | string | The cohorts to send to, comma-separated |
| exclude | query | string | The cohorts to leave out, comma-separated |
Responses
The estimate
{
"people": "integer"
}A cohort is not one, or too many are named
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/marketing-email-audience" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/marketing-email-audience', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/marketing-email-audience'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/marketing-email-audience",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List email templates
The six starters in a language, then the project's saved templates. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| language | query | string | The starters' language; en when left out |
Responses
200 The templates
{
"templates": [
{
"key": "string",
"name": "string",
"isStarter": "boolean",
"content": "unknown",
"updatedAt?": "string | null"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/email/templates" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/templates', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/templates'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/email/templates",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Save an email template
Saves content as one of the project's templates. Needs prodantix.marketing_emails.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"content": "unknown"
}Responses
The template
{
"key": "string",
"name": "string",
"isStarter": "boolean",
"content": "unknown",
"updatedAt?": "string | null"
}The name or content is refused
The plan has no HTML blocks
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/email/templates" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","content":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/templates', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"content": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/templates'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","content":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/email/templates",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","content":"string"},
)Archive an email template
Archives a saved template; emails made from it keep their content. Needs prodantix.marketing_emails.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| templateId required | path | string | The saved template |
Responses
Archived
{
"archived": "boolean"
}No such template
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/email/templates/:templateId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/templates/:templateId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/templates/:templateId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/email/templates/:templateId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read the email brand kit
The project's logo, colours and font for its emails. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
200 The brand kit
{
"logoUrl": "string",
"logoAlt": "string",
"primary": "string",
"onPrimary": "string",
"text": "string",
"background": "string",
"surface": "string",
"font": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/email/brand-kit" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/brand-kit', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/brand-kit'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/email/brand-kit",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Save the email brand kit
Colours are #rrggbb; button text on the primary colour and text on the surface measure at least 4.5:1; the logo is https. Needs prodantix.marketing_emails.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"logoUrl": "string",
"logoAlt": "string",
"primary": "string",
"onPrimary": "string",
"text": "string",
"background": "string",
"surface": "string",
"font": "string"
}Responses
The brand kit
{
"logoUrl": "string",
"logoAlt": "string",
"primary": "string",
"onPrimary": "string",
"text": "string",
"background": "string",
"surface": "string",
"font": "string"
}A colour, the contrast, the logo or the font is refused
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/email/brand-kit" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"logoUrl":"string","logoAlt":"string","primary":"string","onPrimary":"string","text":"string","background":"string","surface":"string","font":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/brand-kit', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"logoUrl": "string",
"logoAlt": "string",
"primary": "string",
"onPrimary": "string",
"text": "string",
"background": "string",
"surface": "string",
"font": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/brand-kit'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"logoUrl":"string","logoAlt":"string","primary":"string","onPrimary":"string","text":"string","background":"string","surface":"string","font":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/email/brand-kit",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"logoUrl":"string","logoAlt":"string","primary":"string","onPrimary":"string","text":"string","background":"string","surface":"string","font":"string"},
)Read the sending settings
The project's hourly rate, quiet hours, frequency cap, approvals and time zone. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
200 The sending settings
{
"hourlyRate": "integer",
"quietStart": "integer",
"quietEnd": "integer",
"frequencyCap": "integer",
"approvalsRequired": "boolean",
"timeZone": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/email/sending-settings" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/sending-settings', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/sending-settings'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/email/sending-settings",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Save the sending settings
The hourly rate is 100 to 10,000, quiet hours whole hours, the frequency cap 0 to 50 a week; requiring approvals needs marketing_email_approvals on the plan. Needs prodantix.email.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Body
{
"hourlyRate": "integer",
"quietStart": "integer",
"quietEnd": "integer",
"frequencyCap": "integer",
"approvalsRequired": "boolean",
"timeZone": "string"
}Responses
The sending settings
{
"hourlyRate": "integer",
"quietStart": "integer",
"quietEnd": "integer",
"frequencyCap": "integer",
"approvalsRequired": "boolean",
"timeZone": "string"
}A setting is refused
The plan has no approvals
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/email/sending-settings" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"hourlyRate":0,"quietStart":0,"quietEnd":0,"frequencyCap":0,"approvalsRequired":true,"timeZone":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/email/sending-settings', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"hourlyRate": 0,
"quietStart": 0,
"quietEnd": 0,
"frequencyCap": 0,
"approvalsRequired": true,
"timeZone": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/email/sending-settings'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"hourlyRate":0,"quietStart":0,"quietEnd":0,"frequencyCap":0,"approvalsRequired":true,"timeZone":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/email/sending-settings",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"hourlyRate":0,"quietStart":0,"quietEnd":0,"frequencyCap":0,"approvalsRequired":true,"timeZone":"string"},
)channels
List push apps
The project's push apps with their credential hints and device counts. Needs prodantix.push.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
200 The apps
{
"apps": [
{
"id": "string",
"name": "string",
"bundleId": "string",
"packageName": "string",
"webOrigin": "string",
"fcmProjectId": "string",
"hasFcm": "boolean",
"fcmHint": "string",
"apnsKeyId": "string",
"apnsTeamId": "string",
"apnsProduction": "boolean",
"hasApns": "boolean",
"apnsHint": "string",
"vapidPublic": "string",
"devices": "integer",
"updatedAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/push/apps" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/push/apps', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/push/apps'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/push/apps",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Add a push app
Adds an app with its iOS bundle, Android package and website, and mints its Web Push keys. Needs prodantix.push.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"bundleId": "string",
"packageName": "string",
"webOrigin": "string"
}Responses
The app
{
"id": "string",
"name": "string",
"bundleId": "string",
"packageName": "string",
"webOrigin": "string",
"fcmProjectId": "string",
"hasFcm": "boolean",
"fcmHint": "string",
"apnsKeyId": "string",
"apnsTeamId": "string",
"apnsProduction": "boolean",
"hasApns": "boolean",
"apnsHint": "string",
"vapidPublic": "string",
"devices": "integer",
"updatedAt": "string"
}A field is refused
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/push/apps" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","bundleId":"string","packageName":"string","webOrigin":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/push/apps', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"bundleId": "string",
"packageName": "string",
"webOrigin": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/push/apps'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","bundleId":"string","packageName":"string","webOrigin":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/push/apps",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","bundleId":"string","packageName":"string","webOrigin":"string"},
)Update a push app
Renames the app or changes its bundle, package or website. Needs prodantix.push.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| appId required | path | string | The push app |
Body
{
"name": "string",
"bundleId": "string",
"packageName": "string",
"webOrigin": "string"
}Responses
The push app
{
"id": "string",
"name": "string",
"bundleId": "string",
"packageName": "string",
"webOrigin": "string",
"fcmProjectId": "string",
"hasFcm": "boolean",
"fcmHint": "string",
"apnsKeyId": "string",
"apnsTeamId": "string",
"apnsProduction": "boolean",
"hasApns": "boolean",
"apnsHint": "string",
"vapidPublic": "string",
"devices": "integer",
"updatedAt": "string"
}A field is refused
No such record
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","bundleId":"string","packageName":"string","webOrigin":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"bundleId": "string",
"packageName": "string",
"webOrigin": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","bundleId":"string","packageName":"string","webOrigin":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","bundleId":"string","packageName":"string","webOrigin":"string"},
)Archive a push app
Archives the app; its devices stop receiving. Needs prodantix.push.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| appId required | path | string | The push app |
Responses
The push app
{
"id": "string",
"name": "string",
"bundleId": "string",
"packageName": "string",
"webOrigin": "string",
"fcmProjectId": "string",
"hasFcm": "boolean",
"fcmHint": "string",
"apnsKeyId": "string",
"apnsTeamId": "string",
"apnsProduction": "boolean",
"hasApns": "boolean",
"apnsHint": "string",
"vapidPublic": "string",
"devices": "integer",
"updatedAt": "string"
}No such record
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Set a push app's Firebase account
Seals the Firebase service account the app's Android notifications are signed with; it is never returned. Needs prodantix.push.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| appId required | path | string | The push app |
Body
{
"serviceAccount": "string"
}Responses
The push app
{
"id": "string",
"name": "string",
"bundleId": "string",
"packageName": "string",
"webOrigin": "string",
"fcmProjectId": "string",
"hasFcm": "boolean",
"fcmHint": "string",
"apnsKeyId": "string",
"apnsTeamId": "string",
"apnsProduction": "boolean",
"hasApns": "boolean",
"apnsHint": "string",
"vapidPublic": "string",
"devices": "integer",
"updatedAt": "string"
}The account does not read
No such record
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId/fcm" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"serviceAccount":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId/fcm', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"serviceAccount": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId/fcm'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"serviceAccount":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId/fcm",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"serviceAccount":"string"},
)Set a push app's Apple key
Seals the .p8 key the app's iOS notifications are signed with, with its key and team ids; it is never returned. Needs prodantix.push.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| appId required | path | string | The push app |
Body
{
"key": "string",
"keyId": "string",
"teamId": "string",
"production": "boolean"
}Responses
The push app
{
"id": "string",
"name": "string",
"bundleId": "string",
"packageName": "string",
"webOrigin": "string",
"fcmProjectId": "string",
"hasFcm": "boolean",
"fcmHint": "string",
"apnsKeyId": "string",
"apnsTeamId": "string",
"apnsProduction": "boolean",
"hasApns": "boolean",
"apnsHint": "string",
"vapidPublic": "string",
"devices": "integer",
"updatedAt": "string"
}The key or an id does not read
No such record
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId/apns" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"key":"string","keyId":"string","teamId":"string","production":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId/apns', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"key": "string",
"keyId": "string",
"teamId": "string",
"production": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId/apns'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"key":"string","keyId":"string","teamId":"string","production":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/push/apps/:appId/apns",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"key":"string","keyId":"string","teamId":"string","production":true},
)Read the Twilio connection
The company's Twilio account sid, messaging service and the end of its auth token. Needs prodantix.sms.read.
Responses
200 The connection
{
"connection?": {
"accountSid": "string",
"authTokenHint": "string",
"messagingServiceSid": "string",
"inboundUrl": "string",
"updatedAt": "string",
"inboxProjectId?": "string | null"
}
}Try it
curl -X GET "https://api.prodantix.com/v1/company/sms/connection" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/sms/connection', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/company/sms/connection'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/company/sms/connection",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Connect Twilio
Connects the company's own Twilio account; its auth token is sealed and checks every webhook Twilio sends. Needs prodantix.sms.manage.
Body
{
"accountSid": "string",
"authToken": "string",
"messagingServiceSid": "string"
}Responses
The connection
{
"accountSid": "string",
"authTokenHint": "string",
"messagingServiceSid": "string",
"inboundUrl": "string",
"updatedAt": "string",
"inboxProjectId?": "string | null"
}A sid or the token is refused
Try it
curl -X PUT "https://api.prodantix.com/v1/company/sms/connection" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"accountSid":"string","authToken":"string","messagingServiceSid":"string"}'const response = await fetch('https://api.prodantix.com/v1/company/sms/connection', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"accountSid": "string",
"authToken": "string",
"messagingServiceSid": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/company/sms/connection'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"accountSid":"string","authToken":"string","messagingServiceSid":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/company/sms/connection",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"accountSid":"string","authToken":"string","messagingServiceSid":"string"},
)Disconnect Twilio
Removes the company's Twilio connection; no text goes out until it is connected again. Needs prodantix.sms.manage.
Responses
200 Whether a connection was removed
{
"removed": "boolean"
}Try it
curl -X DELETE "https://api.prodantix.com/v1/company/sms/connection" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/company/sms/connection', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/company/sms/connection'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/company/sms/connection",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Set the SMS inbox project
Sets the project that texts from a number no send went to land in, as conversations in its inbox; null leaves such texts unwritten. A text answering one of the company's sends always lands in that send's project. Needs prodantix.sms.manage.
Body
{
"projectId?": "string | null"
}Responses
The connection
{
"accountSid": "string",
"authTokenHint": "string",
"messagingServiceSid": "string",
"inboundUrl": "string",
"updatedAt": "string",
"inboxProjectId?": "string | null"
}The project is not one of the company's
No such record
Try it
curl -X PUT "https://api.prodantix.com/v1/company/sms/connection/inbox-project" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"projectId":"string"}'const response = await fetch('https://api.prodantix.com/v1/company/sms/connection/inbox-project', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"projectId": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/company/sms/connection/inbox-project'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"projectId":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/company/sms/connection/inbox-project",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"projectId":"string"},
)List numbers that texted STOP
The project's numbers that texted STOP, the newest first. Needs prodantix.sms.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| search | query | string | The start of a number |
Responses
200 The numbers
{
"opt_outs": [
{
"phone": "string",
"keyword": "string",
"createdAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/sms/opt-outs" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/sms/opt-outs', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/sms/opt-outs'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/sms/opt-outs",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Lift a STOP
Lifts a number's STOP when the person withdrew it another way. Needs prodantix.sms.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| phone required | path | string | The number, in E.164 |
Responses
200 Whether a STOP was lifted
{
"removed": "boolean"
}Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/sms/opt-outs/:phone" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/sms/opt-outs/:phone', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/sms/opt-outs/:phone'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/sms/opt-outs/:phone",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Measure a text
Whether a text goes as plain GSM-7 letters or as UCS-2, its length in those units and the segments it takes.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"text": "string"
}Responses
200 The measure
{
"encoding": "string",
"units": "integer",
"segments": "integer"
}Try it
curl -X POST "https://api.prodantix.com/v1/sms/measure" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"text":"string"}'const response = await fetch('https://api.prodantix.com/v1/sms/measure', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"text": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/sms/measure'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"text":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/sms/measure",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"text":"string"},
)List push and SMS messages
The project's push and SMS campaigns, the latest changed first. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
Responses
200 The messages
{
"messages": [
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/channel-messages" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a push or SMS message
Creates a draft on the push or SMS channel; the channel needs push_channel or sms_channel on the plan. Needs prodantix.marketing_emails.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"channel": "string",
"name": "string",
"kind?": "string | null"
}Responses
The draft
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}The plan does not hold the channel
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/channel-messages" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"channel":"string","name":"string","kind":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"channel": "string",
"name": "string",
"kind": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"channel":"string","name":"string","kind":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"channel":"string","name":"string","kind":"string"},
)Read a push or SMS message
The message with its content, send time, cohorts and approval. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
Responses
The message
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such record
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Save a push or SMS message
Saves content and settings; a scheduled or awaiting message returns to draft and its approval clears. Needs prodantix.marketing_emails.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
Body
{
"name": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send?": "unknown",
"recipients?": "unknown"
}Responses
The message
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}The content or a setting is refused
No such record
The message is not in a state that allows this
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","subscriptionTypeId":"string","appId":"string","content":"string","send":"string","recipients":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"subscriptionTypeId": "string",
"appId": "string",
"content": "string",
"send": "string",
"recipients": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","subscriptionTypeId":"string","appId":"string","content":"string","send":"string","recipients":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","subscriptionTypeId":"string","appId":"string","content":"string","send":"string","recipients":"string"},
)Archive a push or SMS message
Archives a draft, awaiting, sent or cancelled message; its report stays. Needs prodantix.marketing_emails.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
Responses
The message
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such record
The message is not in a state that allows this
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Check a push or SMS message before sending
Everything that stands between the message and its send. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
Responses
The problems
{
"problems": [
{
"code": "string",
"message": "string"
}
]
}No such record
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/readiness" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/readiness', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/readiness'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/readiness",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a push or SMS message's report
Queued, sent, delivered, opened, failed and skipped. Needs prodantix.marketing_emails.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
Responses
The report
{
"queued": "integer",
"sent": "integer",
"delivered": "integer",
"opened": "integer",
"failed": "integer",
"skipped": "integer"
}No such record
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/report" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/report', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/report'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/report",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Send a push or SMS message as a test
Sends the message, led by [Test] and personalised as them, to one person of the project who is subscribed to its type and, for a text, has not replied STOP. The campaign's quiet hours hold for the test, a message takes ten tests a clock hour and a member thirty across every message. Needs prodantix.marketing_emails.send, and prodantix.marketing_emails.approve while the company requires approval and the message is not approved.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"distinctId": "string"
}Responses
How many devices, or the one phone, took it
{
"sent": "integer"
}The plan does not hold the channel
No such record
The test cannot go to the person; details.problems lists why
The message took its ten tests this hour, or the member their thirty
No push service, or Twilio, could be reached
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/test" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"distinctId":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/test', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"distinctId": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/test'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"distinctId":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/test",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"distinctId":"string"},
)Ask for approval
Sends a draft for approval by someone other than its author. Needs prodantix.marketing_emails.manage.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The message
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such record
The message is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/approval-request" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/approval-request', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/approval-request'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/approval-request",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Approve a push or SMS message
Approves a message awaiting approval; the author cannot approve their own. Needs prodantix.marketing_emails.approve.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"note?": "string | null"
}Responses
The message
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}The author cannot approve their own message
No such record
The message is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/approve" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"note":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/approve', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"note": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/approve'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"note":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/approve",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"note":"string"},
)Send a push or SMS message back
Returns a message awaiting approval to draft with a note. Needs prodantix.marketing_emails.approve.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"note?": "string | null"
}Responses
The message
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such record
The message is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/reject" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"note":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/reject', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"note": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/reject'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"note":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/reject",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"note":"string"},
)Schedule a push or SMS message
Schedules a ready draft; a refusal lists every problem in details.problems. Needs prodantix.marketing_emails.send.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The message
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such record
The message is not ready, or not a draft
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/schedule" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/schedule', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/schedule'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/schedule",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Unschedule a push or SMS message
Takes a scheduled message back to draft. Needs prodantix.marketing_emails.send.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The message
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such record
The message is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/unschedule" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/unschedule', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/unschedule'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/unschedule",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Pause a push or SMS message
Holds a sending message's copies not yet sent. Needs prodantix.marketing_emails.send.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The message
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such record
The message is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/pause" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/pause', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/pause'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/pause",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Resume a push or SMS message
Sends a paused message's held copies. Needs prodantix.marketing_emails.send.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The message
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such record
The message is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/resume" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/resume', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/resume'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/resume",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Cancel a push or SMS message
Stops a scheduled, sending or paused message for good; copies not yet sent are skipped. Needs prodantix.marketing_emails.send.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| messageId required | path | string | The push or SMS message |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The message
{
"id": "string",
"projectId": "string",
"channel": "string",
"name": "string",
"kind": "string",
"status": "string",
"subscriptionTypeId?": "string | null",
"appId?": "string | null",
"content": "unknown",
"send": "unknown",
"recipients": "unknown",
"approval": "unknown",
"skipped": "unknown",
"recipientCount": "integer",
"scheduledAt?": "string | null",
"startedAt?": "string | null",
"sentAt?": "string | null",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}No such record
The message is not in a state that allows this
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/cancel" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/cancel', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/cancel'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/channel-messages/:messageId/cancel",
headers={"Authorization": f"Bearer {bearer_auth}"},
)workflows
Enroll a person through a workflow's inbound address
A JSON object naming the person by distinctId or email, with optional properties the run receives as payload. Signed in the x-prodantix-signature header as t={unix seconds},v1={hex HMAC-SHA256 of "{t}.{body}" under the workflow's secret}, and believed within five minutes. A replay of the same request enrolls nobody twice. At most 600 requests a minute and 32 KB a body.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| workflowId required | path | string | The workflow |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The person is on their way into the workflow
The body names nobody or is not the documented object
The signature is missing, wrong or over five minutes old
The company's plan does not include inbound webhooks
No switched-on workflow listens at this address
The body is over 32 KB
Over 600 requests this minute
Try it
curl -X POST "https://api.prodantix.com/v1/workflows/:workflowId/hooks" \
-H "Authorization: Bearer $BILLING_SIGNATURE"const response = await fetch('https://api.prodantix.com/v1/workflows/:workflowId/hooks', {
method: 'POST',
headers: {
Authorization: `Bearer ${billingSignature}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/workflows/:workflowId/hooks'),
headers: {
'Authorization': 'Bearer $billingSignature',
},
);response = requests.post(
"https://api.prodantix.com/v1/workflows/:workflowId/hooks",
headers={"Authorization": f"Bearer {billing_signature}"},
)Read a workflow's inbound address
The address a webhook-triggered workflow listens at and the last four characters of its secret. Needs prodantix.workflows.read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| workflowId required | path | string | The workflow |
Responses
The address
{
"url": "string",
"secretHint?": "string | null"
}No such workflow
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/workflows/:workflowId/hook" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/workflows/:workflowId/hook', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/workflows/:workflowId/hook'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/workflows/:workflowId/hook",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Mint a workflow's signing secret
Mints a new secret for the workflow's inbound address and returns it this once; the old one stops working. Needs prodantix.workflows.update and a plan with inbound webhooks.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project |
| workflowId required | path | string | The workflow |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The new secret
{
"url": "string",
"secret": "string",
"secretHint": "string"
}The plan does not include inbound webhooks
No such workflow
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/workflows/:workflowId/hook/secret" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/workflows/:workflowId/hook/secret', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/workflows/:workflowId/hook/secret'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/workflows/:workflowId/hook/secret",
headers={"Authorization": f"Bearer {bearer_auth}"},
)cohorts
List a cohort's syncs
The destinations a cohort is kept in step with. The destination URL is sealed and only its host is returned.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohort belongs to |
| cohortId required | path | string | The cohort's id |
Responses
200 The syncs
{
"syncs": [
{
"id": "string",
"cohortId": "string",
"name": "string",
"host": "string",
"enabled": "boolean",
"snapshotting": "boolean",
"pending": "integer",
"lastSuccessAt?": "string | null",
"lastError?": "string | null",
"attempts": "integer",
"nextAttemptAt": "string",
"createdAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/syncs" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/syncs', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/syncs'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/syncs",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a cohort sync
Keeps a cohort in step with a signed https webhook: first everyone already in it, then who enters and leaves, in batches of 1000 carrying a batchId to de-duplicate on.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohort belongs to |
| cohortId required | path | string | The cohort's id |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"url?": "string | null",
"enabled?": "boolean | null"
}Responses
The sync
{
"id": "string",
"cohortId": "string",
"name": "string",
"host": "string",
"enabled": "boolean",
"snapshotting": "boolean",
"pending": "integer",
"lastSuccessAt?": "string | null",
"lastError?": "string | null",
"attempts": "integer",
"nextAttemptAt": "string",
"createdAt": "string"
}The name or the destination is invalid
The caller may not sync cohorts
No such cohort
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/syncs" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","url":"string","enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/syncs', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"url": "string",
"enabled": true
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/syncs'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","url":"string","enabled":true}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/syncs",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","url":"string","enabled":true},
)Update a cohort sync
Renames a sync, changes its destination or switches it on or off. A new destination, or switching it back on, sends everyone again.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohort belongs to |
| syncId required | path | string | The sync's id |
Body
{
"name": "string",
"url?": "string | null",
"enabled?": "boolean | null"
}Responses
The sync
{
"id": "string",
"cohortId": "string",
"name": "string",
"host": "string",
"enabled": "boolean",
"snapshotting": "boolean",
"pending": "integer",
"lastSuccessAt?": "string | null",
"lastError?": "string | null",
"attempts": "integer",
"nextAttemptAt": "string",
"createdAt": "string"
}No such sync
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/cohort-syncs/:syncId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","url":"string","enabled":true}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohort-syncs/:syncId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"url": "string",
"enabled": true
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohort-syncs/:syncId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","url":"string","enabled":true}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/cohort-syncs/:syncId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","url":"string","enabled":true},
)Delete a cohort sync
Stops a sync; nothing more is sent.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohort belongs to |
| syncId required | path | string | The sync's id |
Responses
Deleted
No such sync
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/cohort-syncs/:syncId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohort-syncs/:syncId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohort-syncs/:syncId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/cohort-syncs/:syncId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Resync a cohort
Sends everyone in the cohort again, then the changes from now on.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohort belongs to |
| syncId required | path | string | The sync's id |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The sync
{
"id": "string",
"cohortId": "string",
"name": "string",
"host": "string",
"enabled": "boolean",
"snapshotting": "boolean",
"pending": "integer",
"lastSuccessAt?": "string | null",
"lastError?": "string | null",
"attempts": "integer",
"nextAttemptAt": "string",
"createdAt": "string"
}No such sync
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/cohort-syncs/:syncId/resync" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohort-syncs/:syncId/resync', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohort-syncs/:syncId/resync'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/cohort-syncs/:syncId/resync",
headers={"Authorization": f"Bearer {bearer_auth}"},
)List cohort folders
Every cohort folder in the project, parents before their children and siblings in their order.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the folders belong to |
Responses
200 The folders
{
"folders": [
{
"id": "string",
"parentId?": "string | null",
"name": "string",
"position": "integer",
"createdAt": "string",
"updatedAt": "string"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/cohort-folders" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohort-folders', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohort-folders'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/cohort-folders",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Create a cohort folder
Creates a folder under parentId, or at the top level without one, last among its siblings. Folders nest five levels deep, and sibling names are unique ignoring case.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the folders belong to |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"parentId?": "string | null"
}Responses
The folder
{
"id": "string",
"parentId?": "string | null",
"name": "string",
"position": "integer",
"createdAt": "string",
"updatedAt": "string"
}The name is blank or too long, or the folder would nest past five levels
No such parent folder
A sibling already has the name
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/cohort-folders" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","parentId":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohort-folders', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"parentId": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohort-folders'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","parentId":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/cohort-folders",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","parentId":"string"},
)Rename a cohort folder
Renames a folder; sibling names stay unique ignoring case.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the folders belong to |
| folderId required | path | string | The folder's id |
Body
{
"name": "string"
}Responses
The folder
{
"id": "string",
"parentId?": "string | null",
"name": "string",
"position": "integer",
"createdAt": "string",
"updatedAt": "string"
}The name is blank or too long
No such folder
A sibling already has the name
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/cohort-folders/:folderId" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohort-folders/:folderId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohort-folders/:folderId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/cohort-folders/:folderId",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string"},
)Delete a cohort folder
Deletes a folder. Its cohorts and folders move to its parent, so no cohort is deleted with it; refused when a folder it holds shares a name with one already there.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the folders belong to |
| folderId required | path | string | The folder's id |
Responses
Deleted
No such folder
A folder it holds shares a name with one at its parent
Try it
curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/cohort-folders/:folderId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohort-folders/:folderId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.delete(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohort-folders/:folderId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.delete(
"https://api.prodantix.com/v1/projects/:projectId/cohort-folders/:folderId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Move a cohort folder
Moves a folder, with everything it holds, under parentId, or to the top level without one, last among its new siblings.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the folders belong to |
| folderId required | path | string | The folder's id |
Body
{
"parentId?": "string | null"
}Responses
The folder
{
"id": "string",
"parentId?": "string | null",
"name": "string",
"position": "integer",
"createdAt": "string",
"updatedAt": "string"
}The folder would sit inside itself or nest past five levels
No such folder
A folder there already has its name
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/cohort-folders/:folderId/parent" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"parentId":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohort-folders/:folderId/parent', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"parentId": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohort-folders/:folderId/parent'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"parentId":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/cohort-folders/:folderId/parent",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"parentId":"string"},
)Move a cohort to a folder
Puts a cohort in a folder, or at the top level without folderId.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the folders belong to |
| cohortId required | path | string | The cohort's id |
Body
{
"folderId?": "string | null"
}Responses
Moved
No such cohort or folder
Try it
curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/folder" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"folderId":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/folder', {
method: 'PUT',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"folderId": "string"
}),
});
const data = await response.json();final response = await http.put(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/folder'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"folderId":"string"}),
);response = requests.put(
"https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/folder",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"folderId":"string"},
)Start a lookalike cohort
Starts a lookalike of a seed cohort of 20 or more members: the people outside it, most recently active first and up to 50,000, compared with the seed, kept as a new static cohort of the top most alike (100 to 10,000) or of everyone at or above atLeast percent likely. Name one size. Answers the request, whose progress arrives as cohortChange frames; included in the plan, never billed per use.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohorts belong to |
| cohortId required | path | string | The seed cohort |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"name": "string",
"top?": "integer | null",
"atLeast?": "integer | null"
}Responses
The request
{
"id": "string",
"status": "string",
"seedCohortId": "string",
"name": "string",
"top?": "integer | null",
"atLeast?": "integer | null",
"candidates": "integer",
"decided": "integer",
"cohortId?": "string | null",
"failure?": "string | null",
"createdAt": "string",
"finishedAt?": "string | null"
}A blank name, no size or both, a size out of range, or a seed under 20 members
Lookalikes are not in the plan
No such cohort
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/lookalikes" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"name":"string","top":0,"atLeast":0}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/lookalikes', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"top": 0,
"atLeast": 0
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/lookalikes'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"name":"string","top":0,"atLeast":0}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/lookalikes",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"name":"string","top":0,"atLeast":0},
)List lookalike requests
A project's lookalike requests, the newest first, while they are kept.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohorts belong to |
Responses
200 The requests
{
"lookalikes": [
{
"id": "string",
"status": "string",
"seedCohortId": "string",
"name": "string",
"top?": "integer | null",
"atLeast?": "integer | null",
"candidates": "integer",
"decided": "integer",
"cohortId?": "string | null",
"failure?": "string | null",
"createdAt": "string",
"finishedAt?": "string | null"
}
]
}Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/cohort-lookalikes" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohort-lookalikes', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohort-lookalikes'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/cohort-lookalikes",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Read a lookalike request
One lookalike request with its progress and, once done, its cohort.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohorts belong to |
| lookalikeId required | path | string | The lookalike request |
Responses
The request
{
"id": "string",
"status": "string",
"seedCohortId": "string",
"name": "string",
"top?": "integer | null",
"atLeast?": "integer | null",
"candidates": "integer",
"decided": "integer",
"cohortId?": "string | null",
"failure?": "string | null",
"createdAt": "string",
"finishedAt?": "string | null"
}No such lookalike
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/cohort-lookalikes/:lookalikeId" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohort-lookalikes/:lookalikeId', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohort-lookalikes/:lookalikeId'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/cohort-lookalikes/:lookalikeId",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Cancel a lookalike request
Stops a lookalike that has not finished; no cohort is made.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohorts belong to |
| lookalikeId required | path | string | The lookalike request |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Responses
The request
{
"id": "string",
"status": "string",
"seedCohortId": "string",
"name": "string",
"top?": "integer | null",
"atLeast?": "integer | null",
"candidates": "integer",
"decided": "integer",
"cohortId?": "string | null",
"failure?": "string | null",
"createdAt": "string",
"finishedAt?": "string | null"
}The lookalike has already finished
No such lookalike
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/cohort-lookalikes/:lookalikeId/cancel" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohort-lookalikes/:lookalikeId/cancel', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohort-lookalikes/:lookalikeId/cancel'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/cohort-lookalikes/:lookalikeId/cancel",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Preview a cohort definition
Counts a cohort definition being built without saving it: per clause in order, the records it keeps on its own and the records left after it and every clause before it. The definition is checked as a save checks it. Above 1,000,000 records the counts come from a 10% sample, scaled, and are marked as an estimate.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the definition is counted in |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"definition": "unknown",
"object?": "string | null",
"groupType?": "string | null"
}Responses
The counts
{
"clauses": [
{
"alone": "integer",
"remaining": "integer"
}
],
"isEstimate": "boolean",
"records": "integer"
}The definition is not one a cohort could save
Filter insights are not in the plan
A behavioural clause needs the event store, which this deploy cannot reach
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/cohorts/preview" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"definition":"string","object":"string","groupType":"string"}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohorts/preview', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"definition": "string",
"object": "string",
"groupType": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohorts/preview'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"definition":"string","object":"string","groupType":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/cohorts/preview",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"definition":"string","object":"string","groupType":"string"},
)A cohort's makeup
A cohort's members broken down by one property: the top 20 values with their count and share, ten even buckets for a number, or months for a date, and the share with no value. A sensitive property needs the permission to see sensitive properties. Cached for five minutes.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohort belongs to |
| cohortId required | path | string | The cohort to read |
| property required | query | string | The property to break the members down by |
Responses
The makeup
{
"property": "string",
"shape": "string",
"values": [
{
"value": "string",
"count": "integer",
"share": "number"
}
],
"buckets": [
{
"from": "number",
"to": "number",
"count": "integer"
}
],
"noneShare": "number",
"members": "integer"
}Segment analytics are not in the plan
The property is sensitive and the caller may not see its values
No such cohort
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/makeup" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/makeup', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/makeup'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/makeup",
headers={"Authorization": f"Bearer {bearer_auth}"},
)A cohort's overlap
How many of a cohort's members each of up to ten other cohorts of the same kind of record shares, and the share of this cohort that is, largest first. Cached for five minutes.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohort belongs to |
| cohortId required | path | string | The cohort to read |
| cohortIds required | query | string | The cohorts to compare with, comma separated |
Responses
The overlaps
{
"overlaps": [
{
"cohortId": "string",
"shared": "integer",
"share": "number"
}
]
}No cohort, more than ten, the cohort itself, or a cohort of another kind of record
Segment analytics are not in the plan
No such cohort
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/overlap" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/overlap', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/overlap'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/overlap",
headers={"Authorization": f"Bearer {bearer_auth}"},
)A cohort's journey comparison
Over the last 30 days, the 20 events whose count per member differs most between a cohort's members and everyone else, with both rates and the lift. Cached for five minutes.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohort belongs to |
| cohortId required | path | string | The cohort to read |
Responses
The events
{
"events": [
{
"event": "string",
"memberRate": "number",
"everyoneRate": "number",
"lift?": "number | null"
}
]
}Segment analytics are not in the plan
No such cohort
The event store is not reachable from this deploy
Try it
curl -X GET "https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/journey" \
-H "Authorization: Bearer $BEARER_AUTH"const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/journey', {
method: 'GET',
headers: {
Authorization: `Bearer ${bearerAuth}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/journey'),
headers: {
'Authorization': 'Bearer $bearerAuth',
},
);response = requests.get(
"https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/journey",
headers={"Authorization": f"Bearer {bearer_auth}"},
)Sample or split a cohort
Draws a random sample (samplePercent from 1 to 99, or sampleCount up to every member) or an even split (parts from 2 to 10) of a cohort's members as new static cohorts, frozen when made. Name exactly one. The members are ordered by a hash seeded per draw, so a split's parts never overlap and differ in size by at most one.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| projectId required | path | string | The project the cohort belongs to |
| cohortId required | path | string | The cohort to draw from |
| Idempotency-Key | header | string | Up to 255 characters. A retry with the same key within 24 hours answers the first result instead of running again; the same key with a different request answers 409. |
Body
{
"samplePercent?": "integer | null",
"sampleCount?": "integer | null",
"parts?": "integer | null"
}Responses
The cohorts the draw made
{
"cohorts": [
{
"id": "string",
"name": "string",
"definition": "unknown",
"memberCount": "integer",
"folderId?": "string | null",
"createdAt": "string"
}
]
}No draw, more than one, a size out of range, or a cohort with no members or more than 1,000,000
Samples and splits are not in the plan
No such cohort
Try it
curl -X POST "https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/draws" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{"samplePercent":0,"sampleCount":0,"parts":0}'const response = await fetch('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/draws', {
method: 'POST',
headers: {
Authorization: `Bearer ${bearerAuth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"samplePercent": 0,
"sampleCount": 0,
"parts": 0
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/draws'),
headers: {
'Authorization': 'Bearer $bearerAuth',
'Content-Type': 'application/json',
},
body: jsonEncode({"samplePercent":0,"sampleCount":0,"parts":0}),
);response = requests.post(
"https://api.prodantix.com/v1/projects/:projectId/cohorts/:cohortId/draws",
headers={"Authorization": f"Bearer {bearer_auth}"},
json={"samplePercent":0,"sampleCount":0,"parts":0},
)flags
Evaluate all flags for a user
Evaluates every flag in the project against the given distinct id and the user state currently on file.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| distinct_id required | query | string | The end-user identifier to evaluate against. |
Responses
Evaluated flags
{
"flags": "object",
"variants": "object"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Evaluation failed
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/flags" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/flags', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/flags'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/flags",
headers={"Authorization": f"Bearer {project_key}"},
)Fetch the project's full flag ruleset
Returns the project's complete flag ruleset so an SDK can evaluate locally per distinct id. Cacheable: responses carry Cache-Control: public, max-age=30, stale-while-revalidate=300.
Responses
The full flag ruleset
{
"flags": [
{
"description?": "string | null",
"enabled": "boolean",
"type?": "boolean | string | number | json",
"intent?": "release | experiment | operational | kill_switch | permission | sunset",
"key": "string",
"rolloutPercentage": "integer",
"targeting?": [
{
"attribute": "string",
"op": "eq | neq | in | not_in | contains | gt | gte | lt | lte | is_set | is_not_set | in_cohort | not_in_cohort",
"value?": "unknown"
}
],
"variations?": [
{
"key": "string",
"value": "unknown",
"weight": "integer"
}
],
"prerequisites?": [
{
"flagKey": "string",
"variationKey": "string"
}
]
}
],
"generatedAt": "string",
"socketUrl": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Snapshot could not be read
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/flags/snapshot" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/flags/snapshot', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/flags/snapshot'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/flags/snapshot",
headers={"Authorization": f"Bearer {project_key}"},
)Read a user's cohort memberships for local flag evaluation
Returns the ids of the cohorts the distinct id currently belongs to, so an SDK evaluating the snapshot locally can resolve cohort conditions against the same membership store the server uses.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| distinct_id required | query | string | The end-user identifier whose memberships to read. |
Responses
The cohort ids
{
"cohorts": []
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Memberships could not be read
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/flags/memberships" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/flags/memberships', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/flags/memberships'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/flags/memberships",
headers={"Authorization": f"Bearer {project_key}"},
)messaging
Read a user's in-app inbox
Returns the in-app messages targeting an end-user.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| distinct_id required | query | string | The end-user identifier whose inbox to read. |
Responses
The user's in-app messages
{
"messages": [
{
"id": "string",
"title": "string",
"body": "string",
"read": "boolean",
"createdAt": "unknown"
}
]
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Inbox could not be read
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/messages" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/messages', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/messages'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/messages",
headers={"Authorization": f"Bearer {project_key}"},
)Mark an in-app message read
Marks one in-app message read for an end-user.
Body
{
"message_id": "string",
"distinct_id": "string"
}Responses
The message was marked read
{
"ok": "boolean"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Project key belongs to a different region
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The message could not be marked read
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://api.prodantix.com/v1/messages/read" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"message_id":"string","distinct_id":"string"}'const response = await fetch('https://api.prodantix.com/v1/messages/read', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"message_id": "string",
"distinct_id": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/messages/read'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"message_id":"string","distinct_id":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/messages/read",
headers={"Authorization": f"Bearer {project_key}"},
json={"message_id":"string","distinct_id":"string"},
)Upload a file for a form
Keeps a file for a form's upload field, at most 10 MB, its kind decided by its bytes: an image, a PDF or an Office document. Answers the id the file field submits.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| formId required | path | string | The form |
Responses
Kept
{
"fileId": "string",
"contentType": "string"
}The form takes no files
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The file is over 10 MB
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The file is not an image, a PDF or an Office document
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many files from this address this hour
Try it
curl -X POST "https://api.prodantix.com/v1/forms/:formId/files" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/forms/:formId/files', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/forms/:formId/files'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.post(
"https://api.prodantix.com/v1/forms/:formId/files",
headers={"Authorization": f"Bearer {project_key}"},
)Read a published form
The form's published version as the renderer draws it, resolved for the visitor: each progressive field already chosen and known fields left out when the form shortens them. No property or member is named.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| formId required | path | string | The form |
| distinct_id | query | string | The visitor's distinct id, for progressive fields |
Responses
The form
{
"id": "string",
"version": "integer",
"steps": [
{
"title": "string",
"fields": []
}
],
"afterSubmit": "unknown",
"consent": "unknown",
"style": "unknown",
"challenge?": {
"nonce": "string",
"issuedAt": "integer",
"difficulty": "integer",
"signature": "string"
},
"honeypot": "string",
"poweredBy": "boolean",
"accepting": "boolean"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}No published form by that id in this project
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/forms/:formId" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/forms/:formId', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/forms/:formId'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/forms/:formId",
headers={"Authorization": f"Bearer {project_key}"},
)Submit a form
Checks every answer against the published version, writes the mapped properties, identifies an anonymous visitor by the email answered, joins the person to the company its domain names, and answers the thank-you message or redirect.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| formId required | path | string | The form |
Body
{
"distinctId": "string",
"isAnonymous?": "boolean",
"pageUrl?": "string",
"pageId?": "string | null",
"pageVariant?": "string | null",
"answers": "unknown",
"challenge": {
"nonce": "string",
"issuedAt": "integer",
"difficulty": "integer",
"signature": "string"
},
"solution": "string"
}Responses
Taken
{
"afterSubmit": "unknown"
}The distinct id or page address is malformed
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}No published form by that id in this project
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Some answers are refused; error.fields names each with its rule
The submission could not be taken
Try it
curl -X POST "https://api.prodantix.com/v1/forms/:formId/submissions" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"distinctId":"string","isAnonymous":true,"pageUrl":"string","pageId":"string","pageVariant":"string","answers":"string","challenge":"string","solution":"string"}'const response = await fetch('https://api.prodantix.com/v1/forms/:formId/submissions', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"distinctId": "string",
"isAnonymous": true,
"pageUrl": "string",
"pageId": "string",
"pageVariant": "string",
"answers": "string",
"challenge": "string",
"solution": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/forms/:formId/submissions'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"distinctId":"string","isAnonymous":true,"pageUrl":"string","pageId":"string","pageVariant":"string","answers":"string","challenge":"string","solution":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/forms/:formId/submissions",
headers={"Authorization": f"Bearer {project_key}"},
json={"distinctId":"string","isAnonymous":true,"pageUrl":"string","pageId":"string","pageVariant":"string","answers":"string","challenge":"string","solution":"string"},
)Read the CTAs a page may show
The live CTAs a page view may show the visitor: page rules, schedule, audience, device and language decided here, property and cohort conditions against the visitor's own state. Each CTA carries only the variant the visitor is assigned; a flag rule is left to the SDK.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| url required | query | string | The page's address |
| distinct_id required | query | string | The visitor's distinct id |
| anonymous | query | string | Whether the visitor is not yet identified |
| device | query | string | desktop, tablet or mobile |
| language | query | string | The page's language tag |
Responses
The CTAs the page may show
{
"ctas": [
{
"id": "string",
"version": "integer",
"kind": "string",
"placement": "string",
"variant": {
"key": "string",
"content": "unknown",
"style": "unknown"
},
"trigger": "unknown",
"frequency": "unknown",
"flag?": "unknown",
"goalEvent?": "string | null",
"poweredBy": "boolean"
}
]
}A distinct id or address out of bounds
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/ctas" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/ctas', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/ctas'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/ctas",
headers={"Authorization": f"Bearer {project_key}"},
)Read the consent banner a page shows
The project's published consent banner in the page's language, the rule the visitor's region takes (opt_in or notice, decided from the visitor's address), and the day's cookieless id events carry until analytics is granted. Without a published banner the rule is notice and the banner is null.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| language | query | string | The page's language tag |
Responses
The banner, the rule and the day's id
{
"banner?": {
"version": "integer",
"layout": "string",
"categories": [],
"language": "string",
"texts": "unknown",
"style": "unknown",
"policyUrl": "string",
"poweredBy": "boolean",
"poweredByText": "string",
"items": [
{
"name": "string",
"provider": "string",
"category": "string",
"duration": "unknown",
"purpose": "string"
}
]
},
"rule": "string",
"region": "string",
"anonymousId": "string"
}Missing or invalid project key
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/consent" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/consent', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/consent'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/consent",
headers={"Authorization": f"Bearer {project_key}"},
)Record a visitor's answer to the banner
Appends the visitor's answer as a consent record on the person, with the banner version and the region rule. A category the banner does not ask for is recorded as refused.
Body
{
"distinctId": "string",
"version": "integer",
"analytics?": "boolean",
"marketing?": "boolean",
"functional?": "boolean",
"pageUrl?": "string"
}Responses
Recorded
A distinct id or address out of bounds
{
"statusCode": "integer",
"message": "string",
"error": "string"
}No published banner
{
"statusCode": "integer",
"message": "string",
"error": "string"
}The answer is for an older version of the banner
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many answers from one address
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://api.prodantix.com/v1/consent" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"distinctId":"string","version":0,"analytics":true,"marketing":true,"functional":true,"pageUrl":"string"}'const response = await fetch('https://api.prodantix.com/v1/consent', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"distinctId": "string",
"version": 0,
"analytics": true,
"marketing": true,
"functional": true,
"pageUrl": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/consent'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"distinctId":"string","version":0,"analytics":true,"marketing":true,"functional":true,"pageUrl":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/consent",
headers={"Authorization": f"Bearer {project_key}"},
json={"distinctId":"string","version":0,"analytics":true,"marketing":true,"functional":true,"pageUrl":"string"},
)Read a push app's Web Push key
The app's public VAPID key, which the browser's Push API subscribes with. Prodantix mints the pair when the app is created.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| appId required | query | string | The push app |
Responses
The key
{
"publicKey": "string"
}No such push app
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X GET "https://api.prodantix.com/v1/push/vapid" \
-H "Authorization: Bearer $PROJECT_KEY"const response = await fetch('https://api.prodantix.com/v1/push/vapid', {
method: 'GET',
headers: {
Authorization: `Bearer ${projectKey}`,
},
});
const data = await response.json();final response = await http.get(
Uri.parse('https://api.prodantix.com/v1/push/vapid'),
headers: {
'Authorization': 'Bearer $projectKey',
},
);response = requests.get(
"https://api.prodantix.com/v1/push/vapid",
headers={"Authorization": f"Bearer {project_key}"},
)Register a device for push
Registers an APNs or FCM token, or a browser's Push API subscription, for a person on a push app. A token already registered moves to this person and is refreshed.
Body
{
"appId": "string",
"distinctId": "string",
"platform": "string",
"token": "string",
"permission?": "string | null"
}Responses
Registered
{
"id": "string"
}A field out of bounds
{
"statusCode": "integer",
"message": "string",
"error": "string"
}No such push app
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Too many registrations from one address
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://api.prodantix.com/v1/push/devices" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"appId":"string","distinctId":"string","platform":"string","token":"string","permission":"string"}'const response = await fetch('https://api.prodantix.com/v1/push/devices', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"appId": "string",
"distinctId": "string",
"platform": "string",
"token": "string",
"permission": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/push/devices'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"appId":"string","distinctId":"string","platform":"string","token":"string","permission":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/push/devices",
headers={"Authorization": f"Bearer {project_key}"},
json={"appId":"string","distinctId":"string","platform":"string","token":"string","permission":"string"},
)Report a push notification opened
Marks the push a person tapped as opened, and so delivered, by the `send` value its data carried. A second report changes nothing.
Body
{
"sendId": "string"
}Responses
Recorded
The send id is not one
{
"statusCode": "integer",
"message": "string",
"error": "string"
}No such push from this project
{
"statusCode": "integer",
"message": "string",
"error": "string"
}Try it
curl -X POST "https://api.prodantix.com/v1/push/opens" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"sendId":"string"}'const response = await fetch('https://api.prodantix.com/v1/push/opens', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"sendId": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://api.prodantix.com/v1/push/opens'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"sendId":"string"}),
);response = requests.post(
"https://api.prodantix.com/v1/push/opens",
headers={"Authorization": f"Bearer {project_key}"},
json={"sendId":"string"},
)replay
Upload a session replay chunk
Uploads one chunk of a recorded session. Chunks are ordered by seq within a session_id. Both responses are empty-bodied.
Body
{
"distinct_id": "string",
"events": [],
"masked": "boolean",
"schema_version": "integer",
"sdk?": "string | null",
"seq": "integer",
"session_id": "string",
"timestamp": "string"
}Responses
Chunk accepted
Monthly recording quota exceeded
Chunk could not be queued
Try it
curl -X POST "https://eu.replay.prodantix.com/v1/replay" \
-H "Authorization: Bearer $PROJECT_KEY" \
-H "Content-Type: application/json" \
-d '{"distinct_id":"string","events":[],"masked":true,"schema_version":0,"sdk":"string","seq":0,"session_id":"string","timestamp":"string"}'const response = await fetch('https://eu.replay.prodantix.com/v1/replay', {
method: 'POST',
headers: {
Authorization: `Bearer ${projectKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"distinct_id": "string",
"events": [],
"masked": true,
"schema_version": 0,
"sdk": "string",
"seq": 0,
"session_id": "string",
"timestamp": "string"
}),
});
const data = await response.json();final response = await http.post(
Uri.parse('https://eu.replay.prodantix.com/v1/replay'),
headers: {
'Authorization': 'Bearer $projectKey',
'Content-Type': 'application/json',
},
body: jsonEncode({"distinct_id":"string","events":[],"masked":true,"schema_version":0,"sdk":"string","seq":0,"session_id":"string","timestamp":"string"}),
);response = requests.post(
"https://eu.replay.prodantix.com/v1/replay",
headers={"Authorization": f"Bearer {project_key}"},
json={"distinct_id":"string","events":[],"masked":true,"schema_version":0,"sdk":"string","seq":0,"session_id":"string","timestamp":"string"},
)