Liigu põhisisu juurde

API viide

Iga avalik REST-operatsioon koos parameetrite, keha, vastuste ja seda teenindava hostiga. Koodijupid on kopeeritavad; sellelt lehelt ei saadeta ühtegi päringut.

HostServes
https://api.prodantix.comFlags and messaging
https://eu.api.prodantix.comEvent ingestion (EU)
https://eu.replay.prodantix.comSession replay (EU)

billing

GET/v1/planshttps://api.prodantix.com

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.

Auth public

Responses

The plan catalogue

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/plans"
GET/v1/ai/modelshttps://api.prodantix.com

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.

Auth public

Responses

The offered models and their prices

JSON
{
  "markupPercent": "integer",
  "models": [
    {
      "id": "string",
      "displayName": "string",
      "perMillion": {
        "input": "integer",
        "output": "integer",
        "cacheWrite5m": "integer",
        "cacheWrite1h": "integer",
        "cacheRead": "integer"
      }
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/ai/models"
GET/v1/company/add-onshttps://api.prodantix.com

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.

Auth bearerAuth

Responses

200 The catalogue

JSON
{
  "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"
GET/v1/company/held-add-onshttps://api.prodantix.com

List the company's add-ons

The add-ons the company holds, with when a removed one ends. Needs prodantix.billing.read.

Auth bearerAuth

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"
GET/v1/company/add-ons/{addOnKey}/previewhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
addOnKey requiredpathstringThe add-on, as the catalogue names it
quantityqueryintegerHow many units, for an add-on bought in units

Responses

The preview

JSON
{
  "amountDueMinor": "integer",
  "currency": "string",
  "replaces": []
}

Try it

curl -X GET "https://api.prodantix.com/v1/company/add-ons/:addOnKey/preview" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/company/add-ons/{addOnKey}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
addOnKey requiredpathstringThe add-on, as the catalogue names it
Idempotency-KeyheaderstringUp 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

JSON
{
  "quantity?": "integer | null"
}

Responses

The held add-on

JSON
{
  "addOnKey": "string",
  "area?": "string | null",
  "endsAt?": "string | null",
  "kind": "string",
  "quantity": "integer",
  "source": "string"
}

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}'
DELETE/v1/company/add-ons/{addOnKey}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
addOnKey requiredpathstringThe add-on, as the catalogue names it

Responses

The held add-on

JSON
{
  "addOnKey": "string",
  "area?": "string | null",
  "endsAt?": "string | null",
  "kind": "string",
  "quantity": "integer",
  "source": "string"
}

Try it

curl -X DELETE "https://api.prodantix.com/v1/company/add-ons/:addOnKey" \
  -H "Authorization: Bearer $BEARER_AUTH"

analytics

GET/v1/projects/{projectId}/annotationshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the annotations belong to
reportIdquerystringA report whose own annotations are wanted too
from requiredquerystringThe first day, YYYY-MM-DD
to requiredquerystringThe last day, YYYY-MM-DD
limitquerystringAt most this many annotations, 1 to 500 (500 when absent)
afterquerystringThe id of the last annotation of the page before

Responses

The annotations, earliest first

JSON
{
  "annotations": [
    {
      "id": "string",
      "reportId?": "string | null",
      "startsOn": "string",
      "endsOn": "string",
      "text": "string",
      "tags": [],
      "createdByName?": "string | null",
      "createdAt": "string",
      "updatedAt": "string",
      "canChange": "boolean"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/annotations" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/annotationshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the annotations belong to
Idempotency-KeyheaderstringUp 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

JSON
{
  "reportId?": "string | null",
  "startsOn": "string",
  "endsOn?": "string | null",
  "text": "string",
  "tags": []
}

Responses

The annotation as stored

JSON
{
  "id": "string",
  "reportId?": "string | null",
  "startsOn": "string",
  "endsOn": "string",
  "text": "string",
  "tags": [],
  "createdByName?": "string | null",
  "createdAt": "string",
  "updatedAt": "string",
  "canChange": "boolean"
}

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":[]}'
PATCH/v1/projects/{projectId}/annotations/{annotationId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the annotations belong to
annotationId requiredpathstringThe annotation
Idempotency-KeyheaderstringUp 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

JSON
{
  "reportId?": "string | null",
  "startsOn": "string",
  "endsOn?": "string | null",
  "text": "string",
  "tags": []
}

Responses

The annotation as stored

JSON
{
  "id": "string",
  "reportId?": "string | null",
  "startsOn": "string",
  "endsOn": "string",
  "text": "string",
  "tags": [],
  "createdByName?": "string | null",
  "createdAt": "string",
  "updatedAt": "string",
  "canChange": "boolean"
}

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":[]}'
DELETE/v1/projects/{projectId}/annotations/{annotationId}https://api.prodantix.com

Delete an annotation

Removes an annotation from every chart it shows on. Open to its author and to holders of prodantix.annotations.write.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the annotations belong to
annotationId requiredpathstringThe annotation

Responses

Deleted

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/annotations/:annotationId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/reports/{reportId}/public-linkhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
reportId requiredpathstringThe saved report

Responses

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/reports/{reportId}/public-linkhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
reportId requiredpathstringThe saved report

Body

JSON
{
  "expiresOn": "string"
}

Responses

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"}'
DELETE/v1/projects/{projectId}/reports/{reportId}/public-linkhttps://api.prodantix.com

Ends the link at once; its address answers 404 from then on.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
reportId requiredpathstringThe saved report

Responses

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/public-link" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/reports/{reportId}/shareshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
reportId requiredpathstringThe saved report
Idempotency-KeyheaderstringUp 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

JSON
{
  "recipients": [],
  "note?": "string | null",
  "link": "string",
  "language": "string"
}

Responses

How many teammates it was sent to

JSON
{
  "sent": "integer"
}

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"}'
GET/v1/shared-reports/{token}https://api.prodantix.com

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.

Auth public

Parameters

NameInTypeDescription
token requiredpathstringThe link's token, from its address

Responses

The report as last run

JSON
{
  "report": "unknown"
}

Try it

curl -X GET "https://api.prodantix.com/v1/shared-reports/:token"
GET/v1/endpoints/{endpointId}https://api.prodantix.com

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.

Auth public

Parameters

NameInTypeDescription
endpointId requiredpathstringThe endpoint's id

Responses

The report's answer

JSON
{
  "reportId": "string",
  "name": "string",
  "kind": "string",
  "result": "unknown",
  "computedAt": "string"
}

Try it

curl -X GET "https://api.prodantix.com/v1/endpoints/:endpointId"
GET/v1/projects/{projectId}/reports/{reportId}/comment-threadshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
reportId requiredpathstringThe saved report
limitqueryintegerAt most this many threads, 1 to 50 (50 when absent)
afterquerystringThe id of the last thread of the page before

Responses

The threads

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/reports/:reportId/comment-threads" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/reports/{reportId}/comment-threadshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
reportId requiredpathstringThe saved report
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
}

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":[]}'
POST/v1/projects/{projectId}/comment-threads/{threadId}/commentshttps://api.prodantix.com

Reply to a comment thread

Adds a comment to the thread. A thread whose first comment was deleted takes no replies.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
threadId requiredpathstringThe comment thread
Idempotency-KeyheaderstringUp 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

JSON
{
  "body": "string",
  "mentions?": []
}

Responses

The thread as it now stands

JSON
{
  "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"
}

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":[]}'
PATCH/v1/projects/{projectId}/comments/{commentId}https://api.prodantix.com

Change a comment

Replaces the comment's words and mentions. Open to its author only.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
commentId requiredpathstringThe comment
Idempotency-KeyheaderstringUp 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

JSON
{
  "body": "string",
  "mentions?": []
}

Responses

The thread as it now stands

JSON
{
  "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"
}

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":[]}'
DELETE/v1/projects/{projectId}/comments/{commentId}https://api.prodantix.com

Delete a comment

Takes the comment's words back; the thread keeps its place for it. Open to its author only.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
commentId requiredpathstringThe comment

Responses

The thread as it now stands

JSON
{
  "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"
}

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/comments/:commentId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/comment-threads/{threadId}/resolutionhttps://api.prodantix.com

Resolve a comment thread

Marks the thread resolved by the caller. Resolving a resolved thread changes nothing.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
threadId requiredpathstringThe comment thread

Responses

The thread as it now stands

JSON
{
  "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"
}

Try it

curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/resolution" \
  -H "Authorization: Bearer $BEARER_AUTH"
DELETE/v1/projects/{projectId}/comment-threads/{threadId}/resolutionhttps://api.prodantix.com

Reopen a comment thread

Opens a resolved thread again.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
threadId requiredpathstringThe comment thread

Responses

The thread as it now stands

JSON
{
  "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"
}

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/comment-threads/:threadId/resolution" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/comments/{commentId}/reactions/{emoji}https://api.prodantix.com

React to a comment

Adds the caller's reaction. Each person reacts with each emoji once.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
commentId requiredpathstringThe comment
emoji requiredpathstringOne of the six reactions, percent-encoded: 👍 ❤️ 🎯 🎉 🤔 👀

Responses

The thread as it now stands

JSON
{
  "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"
}

Try it

curl -X PUT "https://api.prodantix.com/v1/projects/:projectId/comments/:commentId/reactions/:emoji" \
  -H "Authorization: Bearer $BEARER_AUTH"
DELETE/v1/projects/{projectId}/comments/{commentId}/reactions/{emoji}https://api.prodantix.com

Take back a reaction

Removes the caller's reaction.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the report belongs to
commentId requiredpathstringThe comment
emoji requiredpathstringOne of the six reactions, percent-encoded: 👍 ❤️ 🎯 🎉 🤔 👀

Responses

The thread as it now stands

JSON
{
  "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"
}

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/comments/:commentId/reactions/:emoji" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/warehouse/destinationshttps://api.prodantix.com

List warehouse destinations

The project's warehouse destinations. The secret access key is never returned.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the destination belongs to

Responses

200 The destinations

JSON
{
  "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"
POST/v1/projects/{projectId}/warehouse/destinationshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the destination belongs to
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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 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}'
PUT/v1/projects/{projectId}/warehouse/destinations/{destinationId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the destination belongs to
destinationId requiredpathstringThe destination's id

Body

JSON
{
  "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

JSON
{
  "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 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}'
DELETE/v1/projects/{projectId}/warehouse/destinations/{destinationId}https://api.prodantix.com

Delete a warehouse destination

Stops the sync and deletes the destination's run history. Files already written stay in the bucket.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the destination belongs to
destinationId requiredpathstringThe destination's id

Responses

Deleted

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/warehouse/destinations/:destinationId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/warehouse/destinations/{destinationId}/runshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the destination belongs to
destinationId requiredpathstringThe destination's id

Responses

200 The runs

JSON
{
  "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"
POST/v1/projects/{projectId}/warehouse/destinations/{destinationId}/backfillhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the destination belongs to
destinationId requiredpathstringThe destination's id
Idempotency-KeyheaderstringUp 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

JSON
{
  "from": "string",
  "to": "string"
}

Responses

How many runs were opened

JSON
{
  "opened": "integer"
}

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"}'
GET/v1/projects/{projectId}/warehouse/sourceshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the source belongs to

Responses

The sources

JSON
{
  "sources": [
    {
      "source": "string",
      "views": "integer",
      "visitors": "integer"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/warehouse/sources" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/warehouse/sourceshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the source belongs to
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
      }
    }
  ]
}

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}'
PUT/v1/projects/{projectId}/warehouse/sources/{sourceId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the source belongs to
sourceId requiredpathstringThe source's id

Body

JSON
{
  "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

JSON
{
  "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"
      }
    }
  ]
}

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}'
DELETE/v1/projects/{projectId}/warehouse/sources/{sourceId}https://api.prodantix.com

Delete a warehouse source

Removes a source and drops every table it loaded.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the source belongs to
sourceId requiredpathstringThe source's id

Responses

Deleted

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/warehouse/sources/{sourceId}/tableshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the source belongs to
sourceId requiredpathstringThe source's id
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string",
  "prefix?": "string",
  "format?": "string",
  "object?": "string | null",
  "sourceSchema?": "string | null",
  "sourceTable?": "string | null"
}

Responses

The source

JSON
{
  "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"
      }
    }
  ]
}

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"}'
DELETE/v1/projects/{projectId}/warehouse/sources/{sourceId}/tables/{tableId}https://api.prodantix.com

Remove a table from a warehouse source

Stops loading the table and drops what it loaded.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the source belongs to
sourceId requiredpathstringThe source's id
tableId requiredpathstringThe table's id

Responses

The source

JSON
{
  "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"
      }
    }
  ]
}

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/tables/:tableId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/warehouse/sources/{sourceId}/runhttps://api.prodantix.com

Run a warehouse source now

Loads the source's tables on the next pass, within a minute, beside its schedule.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the source belongs to
sourceId requiredpathstringThe source's id
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
      }
    }
  ]
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/warehouse/sources/:sourceId/run" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/warehouse/modelshttps://api.prodantix.com

List warehouse models

The saved SQL a project reads as tables beside its events and sources, each with its last run.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the model belongs to

Responses

The models

JSON
{
  "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"
      }
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/warehouse/models" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/warehouse/modelshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the model belongs to
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string",
  "sql": "string",
  "kind?": "string",
  "schedule?": "string",
  "enabled?": "boolean | null"
}

Responses

The model

JSON
{
  "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"
  }
}

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}'
PUT/v1/projects/{projectId}/warehouse/models/{modelId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the model belongs to
modelId requiredpathstringThe model's id

Body

JSON
{
  "name": "string",
  "sql": "string",
  "kind?": "string",
  "schedule?": "string",
  "enabled?": "boolean | null"
}

Responses

The model

JSON
{
  "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"
  }
}

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}'
DELETE/v1/projects/{projectId}/warehouse/models/{modelId}https://api.prodantix.com

Delete a warehouse model

Removes a model and drops its view or table.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the model belongs to
modelId requiredpathstringThe model's id

Responses

Deleted

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/warehouse/models/{modelId}/runshttps://api.prodantix.com

List a warehouse model's runs

A table model's last 20 refreshes, newest first.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the model belongs to
modelId requiredpathstringThe model's id

Responses

The runs

JSON
{
  "runs": [
    {
      "state": "string",
      "rows?": "integer | null",
      "bytes?": "integer | null",
      "failure?": "string | null",
      "startedAt": "string",
      "finishedAt?": "string | null"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId/runs" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/warehouse/models/{modelId}/runhttps://api.prodantix.com

Refresh a warehouse model now

Refreshes a table model on the next pass, within a minute, beside its schedule. A view has no run.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the model belongs to
modelId requiredpathstringThe model's id
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
  }
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/warehouse/models/:modelId/run" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/warehouse/models/previewhttps://api.prodantix.com

Preview a warehouse model

Runs a model's SQL as the project and answers its first 20 rows; nothing is saved.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the model belongs to
Idempotency-KeyheaderstringUp 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

JSON
{
  "sql": "string"
}

Responses

The first rows

JSON
{
  "columns": [
    {
      "name": "string",
      "type": "string"
    }
  ],
  "rows": [],
  "rowsRead": "integer",
  "elapsedMs": "integer",
  "truncated": "boolean"
}

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"}'
POST/v1/projects/{projectId}/sqlhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project to query
Idempotency-KeyheaderstringUp 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

JSON
{
  "sql": "string"
}

Responses

The rows

JSON
{
  "columns": [
    {
      "name": "string",
      "type": "string"
    }
  ],
  "rows": [],
  "rowsRead": "integer",
  "elapsedMs": "integer",
  "truncated": "boolean"
}

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"}'

people

GET/v1/projects/{projectId}/crm/definitionshttps://api.prodantix.com

List property definitions

The definitions of a project's people, or of one company type, ordered by label.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company
includeArchivedquerystringtrue to list archived definitions too

Responses

List property definitions

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/definitions" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/definitionshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
}

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}'
PATCH/v1/projects/{projectId}/crm/definitions/{definitionId}https://api.prodantix.com

Change a property definition

Rewrites everything but the name, the object and the type.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
definitionId requiredpathstringThe property definition
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
}

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}'
POST/v1/projects/{projectId}/crm/definitions/{definitionId}/archivehttps://api.prodantix.com

Archive or restore a property definition

An archived definition stops checking values and leaves the Details tab; the values stay on the records.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
definitionId requiredpathstringThe property definition
Idempotency-KeyheaderstringUp 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

JSON
{
  "archived": "boolean"
}

Responses

Archive or restore a property definition

JSON
{
  "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"
}

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}'
PUT/v1/projects/{projectId}/crm/built-in-properties/sensitivehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Body

JSON
{
  "object": "string",
  "groupType?": "string",
  "property": "string",
  "sensitive": "boolean"
}

Responses

Mark a built-in property sensitive

JSON
{
  "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"
}

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}'
GET/v1/projects/{projectId}/crm/data-qualityhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company

Responses

Read refused and undefined properties

JSON
{
  "drops": [
    {
      "name": "string",
      "reason": "string",
      "count": "integer",
      "lastSeenAt": "string",
      "lastValue": "string"
    }
  ],
  "undefined": [
    {
      "name": "string",
      "count": "integer",
      "lastSeenAt": "string",
      "samples": [],
      "suggestedType": "string"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/data-quality" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/groupshttps://api.prodantix.com

List property groups

The sections of a record's Details tab, in order.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company

Responses

List property groups

JSON
{
  "groups": [
    {
      "id": "string",
      "name": "string",
      "position": "integer"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/groups" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/groupshttps://api.prodantix.com

Add a property group

Adds a section after the last one.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "object": "string",
  "groupType?": "string",
  "name": "string"
}

Responses

Add a property group

JSON
{
  "id": "string",
  "name": "string",
  "position": "integer"
}

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"}'
PATCH/v1/projects/{projectId}/crm/groups/{groupId}https://api.prodantix.com

Rename a property group

Renames a section of the Details tab.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
groupId requiredpathstringThe property group
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string"
}

Responses

Rename a property group

JSON
{
  "id": "string",
  "name": "string",
  "position": "integer"
}

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"}'
DELETE/v1/projects/{projectId}/crm/groups/{groupId}https://api.prodantix.com

Delete a property group

Deletes a section; its properties stay, in no section.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
groupId requiredpathstringThe property group

Responses

Delete a property group

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/groups/:groupId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/crm/group-orderhttps://api.prodantix.com

Order property groups

Orders the sections as ids lists them.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Body

JSON
{
  "object": "string",
  "groupType?": "string",
  "ids": []
}

Responses

Order property groups

JSON
{
  "groups": [
    {
      "id": "string",
      "name": "string",
      "position": "integer"
    }
  ]
}

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":[]}'
POST/v1/projects/{projectId}/crm/records/savehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "record": {
    "object": "string",
    "groupType?": "string",
    "subject": "string"
  },
  "set?": "object",
  "unset?": []
}

Responses

Save a record

JSON
{
  "eventId": "string",
  "folded": "boolean",
  "properties?": "object | null",
  "refused": [
    {
      "field": "string",
      "rule": "string"
    }
  ]
}

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":[]}'
POST/v1/projects/{projectId}/crm/records/bulkhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "records": [
    {
      "object": "string",
      "groupType?": "string",
      "subject": "string"
    }
  ],
  "key": "string",
  "value?": "unknown",
  "clear?": "boolean"
}

Responses

Edit records in bulk

JSON
{
  "jobId": "string",
  "total": "integer"
}

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}'
GET/v1/projects/{projectId}/crm/labelshttps://api.prodantix.com

List association labels

A company type's labels for a person's link to a company, in order.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
groupType requiredquerystringThe company type

Responses

List association labels

JSON
{
  "labels": [
    {
      "id": "string",
      "groupType": "string",
      "name": "string",
      "position": "integer"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/labels" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/labelshttps://api.prodantix.com

Add an association label

Adds a label after the company type's last one.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "groupType": "string",
  "name": "string"
}

Responses

Add an association label

JSON
{
  "id": "string",
  "groupType": "string",
  "name": "string",
  "position": "integer"
}

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"}'
PATCH/v1/projects/{projectId}/crm/labels/{labelId}https://api.prodantix.com

Rename an association label

Renames a label everywhere it is on.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
labelId requiredpathstringThe association label
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string"
}

Responses

Rename an association label

JSON
{
  "id": "string",
  "groupType": "string",
  "name": "string",
  "position": "integer"
}

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"}'
DELETE/v1/projects/{projectId}/crm/labels/{labelId}https://api.prodantix.com

Delete an association label

Deletes a label and takes it off every link it was on.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
labelId requiredpathstringThe association label

Responses

Delete an association label

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/labels/:labelId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/crm/label-orderhttps://api.prodantix.com

Order association labels

Orders a company type's labels as ids lists them.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Body

JSON
{
  "groupType": "string",
  "ids": []
}

Responses

Order association labels

JSON
{
  "labels": [
    {
      "id": "string",
      "groupType": "string",
      "name": "string",
      "position": "integer"
    }
  ]
}

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":[]}'
GET/v1/projects/{projectId}/crm/link-labelshttps://api.prodantix.com

The labels on a person's links (distinctId) or on a company's (groupType and groupKey).

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
distinctIdquerystringThe person
groupTypequerystringThe company type
groupKeyquerystringThe company

Responses

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/link-labels" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/crm/link-labelshttps://api.prodantix.com

Puts a label on a person's link to a company; a label already on it stays. Needs prodantix.users.write.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Body

JSON
{
  "distinctId": "string",
  "groupType": "string",
  "groupKey": "string",
  "labelId": "string"
}

Responses

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"}'
POST/v1/projects/{projectId}/crm/link-labels/removehttps://api.prodantix.com

Take a label off a link

Takes a label off a person's link to a company.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "distinctId": "string",
  "groupType": "string",
  "groupKey": "string",
  "labelId": "string"
}

Responses

Take a label off a link

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"}'
GET/v1/projects/{projectId}/crm/viewshttps://api.prodantix.com

List saved views

The caller's own views and the project's, in order, each saying whether the caller may change it.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company

Responses

List saved views

JSON
{
  "views": [
    {
      "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/views" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/viewshttps://api.prodantix.com

Save a view

Saves filters, sort, columns and a table, board or calendar layout, private to the caller or shared with the project.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
}

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"}'
GET/v1/projects/{projectId}/crm/views/{viewId}https://api.prodantix.com

Read a saved view

One view the caller can see.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
viewId requiredpathstringThe saved view

Responses

Read a saved view

JSON
{
  "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"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PATCH/v1/projects/{projectId}/crm/views/{viewId}https://api.prodantix.com

Change a saved view

Rewrites a view. Open to its owner, and on a project view to holders of prodantix.views.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
viewId requiredpathstringThe saved view
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
}

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"}'
DELETE/v1/projects/{projectId}/crm/views/{viewId}https://api.prodantix.com

Delete a saved view

Deletes a view, under the same rule as changing it.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
viewId requiredpathstringThe saved view

Responses

Delete a saved view

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/views/:viewId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/crm/view-orderhttps://api.prodantix.com

Order saved views

Orders the views as ids lists them; a view the caller may not change keeps its place.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Body

JSON
{
  "object": "string",
  "groupType?": "string",
  "ids": []
}

Responses

Order saved views

JSON
{
  "views": [
    {
      "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"
    }
  ]
}

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":[]}'
GET/v1/projects/{projectId}/crm/timelinehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company
subject requiredquerystringThe person's distinct id, or the company's key
kindsquerystringComma-separated: event, session, message, conversation, property_change, task, note, activity, tag, membership
beforequerystringThe nextCursor of the page before
limitquerystringAt most this many entries, 1 to 100 (50 when absent)
membersquerystringOn a company, false to leave its members' events out

Responses

Read a record's timeline

JSON
{
  "entries": [
    {
      "at": "string",
      "kind": "string",
      "id": "string",
      "detail": "unknown"
    }
  ],
  "nextCursor?": "string | null"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/timeline" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/taskshttps://api.prodantix.com

List tasks

The project's tasks by status, owner and due time, the soonest due first, at most 500.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
statusquerystringopen or done
ownerSubquerystringThe owner
dueBeforequerystringDue before this RFC 3339 time

Responses

List tasks

JSON
{
  "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"
        }
      ]
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/tasks" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/taskshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
    }
  ]
}

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":[]}'
PATCH/v1/projects/{projectId}/crm/tasks/{taskId}https://api.prodantix.com

Change a task

Rewrites a task; a changed reminder is sent again.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
taskId requiredpathstringThe task
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
    }
  ]
}

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":[]}'
DELETE/v1/projects/{projectId}/crm/tasks/{taskId}https://api.prodantix.com

Delete a task

Removes a task from every record it is on.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
taskId requiredpathstringThe task

Responses

Delete a task

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/tasks/:taskId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/tasks/{taskId}/completehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
taskId requiredpathstringThe task
Idempotency-KeyheaderstringUp 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

JSON
{
  "done?": "boolean"
}

Responses

Complete or reopen a task

JSON
{
  "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"
      }
    ]
  }
}

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}'
POST/v1/projects/{projectId}/crm/noteshttps://api.prodantix.com

Write a note

A note on people and companies, in the console's rich text. Needs prodantix.users.write.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "body": "unknown",
  "pinned?": "boolean",
  "records?": [
    {
      "object": "string",
      "groupType?": "string",
      "subject": "string"
    }
  ]
}

Responses

Write a note

JSON
{
  "id": "string",
  "body": "unknown",
  "pinned": "boolean",
  "createdBy": "string",
  "updatedBy": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "records": [
    {
      "object": "string",
      "groupType": "string",
      "subject": "string"
    }
  ]
}

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":[]}'
PATCH/v1/projects/{projectId}/crm/notes/{noteId}https://api.prodantix.com

Change a note

Rewrites a note's text or pin. Open to its author and to holders of prodantix.users.write.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
noteId requiredpathstringThe note
Idempotency-KeyheaderstringUp 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

JSON
{
  "body": "unknown",
  "pinned?": "boolean",
  "records?": [
    {
      "object": "string",
      "groupType?": "string",
      "subject": "string"
    }
  ]
}

Responses

Change a note

JSON
{
  "id": "string",
  "body": "unknown",
  "pinned": "boolean",
  "createdBy": "string",
  "updatedBy": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "records": [
    {
      "object": "string",
      "groupType": "string",
      "subject": "string"
    }
  ]
}

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":[]}'
DELETE/v1/projects/{projectId}/crm/notes/{noteId}https://api.prodantix.com

Delete a note

Removes a note, under the same rule as changing it.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
noteId requiredpathstringThe note

Responses

Delete a note

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/notes/:noteId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/activitieshttps://api.prodantix.com

Log an activity

Logs a call, meeting or email against people and companies, with its outcome, direction and duration.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
    }
  ]
}

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":[]}'
DELETE/v1/projects/{projectId}/crm/activities/{activityId}https://api.prodantix.com

Delete an activity

Removes a logged activity.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
activityId requiredpathstringThe activity

Responses

Delete an activity

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/activities/:activityId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/tagshttps://api.prodantix.com

List tags

The project's tags, by name.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Responses

List tags

JSON
{
  "tags": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/tags" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/tagshttps://api.prodantix.com

Add a tag

A tag people and companies can carry; the console colours it from its id. Needs prodantix.properties.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string"
}

Responses

Add a tag

JSON
{
  "id": "string",
  "name": "string"
}

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"}'
PATCH/v1/projects/{projectId}/crm/tags/{tagId}https://api.prodantix.com

Change a tag

Renames a tag everywhere it is on.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
tagId requiredpathstringThe tag
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string"
}

Responses

Change a tag

JSON
{
  "id": "string",
  "name": "string"
}

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"}'
DELETE/v1/projects/{projectId}/crm/tags/{tagId}https://api.prodantix.com

Delete a tag

Deletes a tag and takes it off every record.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
tagId requiredpathstringThe tag

Responses

Delete a tag

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/tags/:tagId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/record-tagshttps://api.prodantix.com

Read a record's tags

The tags on one person or company.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company
subject requiredquerystringThe person's distinct id, or the company's key

Responses

Read a record's tags

JSON
{
  "tags": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/record-tags" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/crm/record-tagshttps://api.prodantix.com

Tag a record

Puts a tag on a person or company. Needs prodantix.users.write.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Body

JSON
{
  "tagId": "string",
  "record": {
    "object": "string",
    "groupType?": "string",
    "subject": "string"
  }
}

Responses

Tag a record

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"}'
POST/v1/projects/{projectId}/crm/record-tags/removehttps://api.prodantix.com

Untag a record

Takes a tag off a person or company.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "tagId": "string",
  "record": {
    "object": "string",
    "groupType?": "string",
    "subject": "string"
  }
}

Responses

Untag a record

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"}'
GET/v1/projects/{projectId}/crm/lifecycle/ruleshttps://api.prodantix.com

List lifecycle rules

One object's stage rules, at most one per stage, each with the cohort definition that moves a record into it.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company

Responses

List lifecycle rules

JSON
{
  "rules": [
    {
      "id": "string",
      "stage": "string",
      "definition": "unknown",
      "enabled": "boolean"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/lifecycle/ruleshttps://api.prodantix.com

Add a lifecycle rule

The conditions that move a record forward into a stage. Rules never move a stage back. Needs prodantix.properties.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "object": "string",
  "groupType?": "string",
  "stage": "string",
  "definition": "unknown",
  "enabled?": "boolean"
}

Responses

Add a lifecycle rule

JSON
{
  "id": "string",
  "stage": "string",
  "definition": "unknown",
  "enabled": "boolean"
}

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}'
PATCH/v1/projects/{projectId}/crm/lifecycle/rules/{ruleId}https://api.prodantix.com

Change a lifecycle rule

Rewrites a stage rule's conditions, or switches it on or off.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
ruleId requiredpathstringThe rule
Idempotency-KeyheaderstringUp 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

JSON
{
  "object": "string",
  "groupType?": "string",
  "stage": "string",
  "definition": "unknown",
  "enabled?": "boolean"
}

Responses

Change a lifecycle rule

JSON
{
  "id": "string",
  "stage": "string",
  "definition": "unknown",
  "enabled": "boolean"
}

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}'
DELETE/v1/projects/{projectId}/crm/lifecycle/rules/{ruleId}https://api.prodantix.com

Delete a lifecycle rule

Records stay where they are; no rule moves them into that stage again.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
ruleId requiredpathstringThe rule

Responses

Delete a lifecycle rule

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/rules/:ruleId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/lifecycle/stageshttps://api.prodantix.com

Count records by stage

How many of one object's records hold each stage now, in stage order.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company

Responses

Count records by stage

JSON
{
  "stages": [
    {
      "stage": "string",
      "count": "integer"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/stages" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/lifecycle/reporthttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company
from requiredquerystringThe range's start, RFC 3339
to requiredquerystringThe range's end, RFC 3339

Responses

Read the Lifecycle stages report

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/report" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/lifecycle/settingshttps://api.prodantix.com

Read the lifecycle setting

Whether the project lets a stage move backwards.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Responses

Read the lifecycle setting

JSON
{
  "backwards": "boolean"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/lifecycle/settings" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/crm/lifecycle/settingshttps://api.prodantix.com

Change the lifecycle setting

Lets a stage move backwards, or holds every record to moving forward. Needs prodantix.properties.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Body

JSON
{
  "backwards": "boolean"
}

Responses

Change the lifecycle setting

JSON
{
  "backwards": "boolean"
}

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}'
GET/v1/projects/{projectId}/crm/routing/ruleshttps://api.prodantix.com

List routing rules

One object's routing rules in the order they are tried, each with its owners and who is next.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company

Responses

List routing rules

JSON
{
  "rules": [
    {
      "id": "string",
      "name": "string",
      "onStage?": "string | null",
      "definition": "unknown",
      "owners": [],
      "nextOwner?": "string | null",
      "position": "integer",
      "enabled": "boolean"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/routing/ruleshttps://api.prodantix.com

Add a routing rule

Hands records arriving without an owner, or entering a stage, to members in turn. Needs prodantix.properties.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "object": "string",
  "groupType?": "string",
  "name": "string",
  "onStage?": "string | null",
  "definition": "unknown",
  "owners": [],
  "enabled?": "boolean"
}

Responses

Add a routing rule

JSON
{
  "id": "string",
  "name": "string",
  "onStage?": "string | null",
  "definition": "unknown",
  "owners": [],
  "nextOwner?": "string | null",
  "position": "integer",
  "enabled": "boolean"
}

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}'
PATCH/v1/projects/{projectId}/crm/routing/rules/{ruleId}https://api.prodantix.com

Change a routing rule

Rewrites a routing rule; new owners start the turn over.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
ruleId requiredpathstringThe rule
Idempotency-KeyheaderstringUp 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

JSON
{
  "object": "string",
  "groupType?": "string",
  "name": "string",
  "onStage?": "string | null",
  "definition": "unknown",
  "owners": [],
  "enabled?": "boolean"
}

Responses

Change a routing rule

JSON
{
  "id": "string",
  "name": "string",
  "onStage?": "string | null",
  "definition": "unknown",
  "owners": [],
  "nextOwner?": "string | null",
  "position": "integer",
  "enabled": "boolean"
}

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}'
DELETE/v1/projects/{projectId}/crm/routing/rules/{ruleId}https://api.prodantix.com

Delete a routing rule

Records keep the owners it gave them.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
ruleId requiredpathstringThe rule

Responses

Delete a routing rule

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/routing/rules/:ruleId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/crm/routing/orderhttps://api.prodantix.com

Reorder routing rules

The order routing rules are tried in, every rule named once.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Body

JSON
{
  "ruleIds": []
}

Responses

Reorder routing rules

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":[]}'
POST/v1/projects/{projectId}/crm/imports/fileshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company
Idempotency-KeyheaderstringUp 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

JSON
{
  "fileId": "string",
  "size": "integer",
  "columns": [
    {
      "name": "string",
      "samples": [],
      "proposal": "unknown"
    }
  ]
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/imports/files" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/importshttps://api.prodantix.com

List imports

The project's imports, the newest first, while they are kept (90 days).

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Responses

List imports

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/imports" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/importshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "fileId": "string",
  "fileName?": "string",
  "object": "string",
  "groupType?": "string",
  "mode": "string",
  "overwrite": "string",
  "header": [],
  "columns": "unknown",
  "newProperties?": "unknown"
}

Responses

Start an import

JSON
{
  "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"
}

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"}'
GET/v1/projects/{projectId}/crm/imports/{importId}https://api.prodantix.com

Read an import

An import's status and its counts of rows read, created, updated, skipped and refused.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
importId requiredpathstringThe import

Responses

Read an import

JSON
{
  "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"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/imports/{importId}/cancelhttps://api.prodantix.com

Cancel an import

Stops a waiting or running import; the rows it already wrote stay.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
importId requiredpathstringThe import
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId/cancel" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/imports/{importId}/rows.csvhttps://api.prodantix.com

Download skipped and refused rows

Every row the import skipped or refused, as the file had it, with the outcome and the reason.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
importId requiredpathstringThe import

Responses

Download skipped and refused rows

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/imports/:importId/rows.csv" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/exportshttps://api.prodantix.com

List exports

The project's queued exports, the newest first, while their files are kept.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Responses

List exports

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/exports" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/exportshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "object": "string",
  "groupType?": "string",
  "viewId?": "string | null",
  "search?": "string | null",
  "columns": [],
  "format?": "string"
}

Responses

Export people or companies

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"}'
GET/v1/projects/{projectId}/crm/exports/{exportId}https://api.prodantix.com

Read an export

A queued export's status, the rows it has written and whether its file is ready.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
exportId requiredpathstringThe export

Responses

Read an export

JSON
{
  "id": "string",
  "status": "string",
  "object": "string",
  "format": "string",
  "rows": "integer",
  "ready": "boolean",
  "failure?": "string | null",
  "createdBy": "string",
  "createdAt": "string",
  "finishedAt?": "string | null",
  "expiresAt": "string"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/exports/{exportId}/cancelhttps://api.prodantix.com

Cancel an export

Stops a queued export; it leaves no file.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
exportId requiredpathstringThe export
Idempotency-KeyheaderstringUp 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

JSON
{
  "id": "string",
  "status": "string",
  "object": "string",
  "format": "string",
  "rows": "integer",
  "ready": "boolean",
  "failure?": "string | null",
  "createdBy": "string",
  "createdAt": "string",
  "finishedAt?": "string | null",
  "expiresAt": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId/cancel" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/exports/{exportId}/filehttps://api.prodantix.com

Download an export

A finished export's file.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
exportId requiredpathstringThe export

Responses

Download an export

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/exports/:exportId/file" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/scoreshttps://api.prodantix.com

List scores

The project's lead scores with their groups, tiers and the two properties each writes. Needs lead scoring in the plan.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
objectquerystringOnly scores of person or company
groupTypequerystringThe company type, for object company

Responses

List scores

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/scores" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/scoreshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
}

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"}'
PUT/v1/projects/{projectId}/crm/scores/{scoreId}https://api.prodantix.com

Update a score

Rewrites a score's groups, tiers and decay and scores every record once more. Needs prodantix.properties.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
scoreId requiredpathstringThe score

Body

JSON
{
  "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

JSON
{
  "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"
}

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"}'
DELETE/v1/projects/{projectId}/crm/scores/{scoreId}https://api.prodantix.com

Delete a score

Removes a score; its two properties are archived with their values. Needs prodantix.properties.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
scoreId requiredpathstringThe score

Responses

Delete a score

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/scores/{scoreId}/rescorehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
scoreId requiredpathstringThe score
Idempotency-KeyheaderstringUp 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

JSON
{
  "jobId": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/scores/:scoreId/rescore" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/score-historyhttps://api.prodantix.com

A record's score history

Each change of a record's scores, newest first, with its fit and engagement parts and what caused it.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
subject requiredquerystringThe record: a person's id, or a company's key
scoreIdquerystringOnly this score's changes
sincequerystringChanges from this RFC 3339 time; 30 days back by default

Responses

A record's score history

JSON
{
  "changes": [
    {
      "scoreId": "string",
      "value": "integer",
      "tier?": "string | null",
      "fit": "integer",
      "engagement": "integer",
      "cause": "string",
      "at": "string"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/score-history" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/duplicateshttps://api.prodantix.com

List duplicates

One object's open duplicate pairs, the exact matches first, with both records' properties.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company

Responses

List duplicates

JSON
{
  "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"
      }
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/duplicates" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/duplicates/dismisshttps://api.prodantix.com

Dismiss duplicates

Marks pairs not duplicates; a pair comes back only on a signal it did not have.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "duplicateIds": []
}

Responses

Dismiss duplicates

JSON
{
  "dismissed": "integer"
}

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":[]}'
POST/v1/projects/{projectId}/crm/duplicates/{duplicateId}/mergehttps://api.prodantix.com

Merge a duplicate pair

Keeps the record keep names; the other's values fill only what it has empty, and its links move across.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
duplicateId requiredpathstringThe pair
Idempotency-KeyheaderstringUp 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

JSON
{
  "keep": "string"
}

Responses

Merge a duplicate pair

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"}'
POST/v1/projects/{projectId}/crm/duplicates/refreshhttps://api.prodantix.com

Look for duplicates now

Searches the project's people and companies now rather than at the next daily pass.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "jobId": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/refresh" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/duplicates/settingshttps://api.prodantix.com

Read the duplicates setting

Whether exact email and domain matches merge on their own.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Responses

Read the duplicates setting

JSON
{
  "autoMerge": "boolean"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/duplicates/settings" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/crm/duplicates/settingshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Body

JSON
{
  "autoMerge": "boolean"
}

Responses

Change the duplicates setting

JSON
{
  "autoMerge": "boolean"
}

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}'
GET/v1/projects/{projectId}/crm/format-ruleshttps://api.prodantix.com

List formatting rules

Every property of one object that carries formatting rules, built-in properties with their defaults.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company

Responses

List formatting rules

JSON
{
  "properties": [
    {
      "property": "string",
      "rules": [
        {
          "rule": "string",
          "mode": "string",
          "country?": "string | null"
        }
      ]
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/format-rules" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/crm/format-rules/{property}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
property requiredpathstringThe property's name

Body

JSON
{
  "object": "string",
  "groupType?": "string",
  "rules": [
    {
      "rule": "string",
      "mode": "string",
      "country?": "string | null"
    }
  ]
}

Responses

Set a property's formatting rules

JSON
{
  "rules": [
    {
      "rule": "string",
      "mode": "string",
      "country?": "string | null"
    }
  ]
}

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":[]}'
GET/v1/projects/{projectId}/crm/format-issueshttps://api.prodantix.com

List formatting issues

One object's values a formatting rule would change, by property then record, after a cursor.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company
propertyquerystringOnly this property's issues
rulequerystringOnly the issues raised under this rule
afterPropertyquerystringThe cursor's property
afterSubjectquerystringThe cursor's record
limitquerystringAt most this many, up to 200

Responses

List formatting issues

JSON
{
  "issues": [
    {
      "subject": "string",
      "property": "string",
      "rules": [],
      "current": "string",
      "suggested": "string"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/format-issues" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/format-issues/countshttps://api.prodantix.com

Count formatting issues

How many issues each property holds under each rule.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company

Responses

Count formatting issues

JSON
{
  "counts": [
    {
      "property": "string",
      "rule": "string",
      "count": "integer"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/format-issues/counts" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/format-issues/{property}/applyhttps://api.prodantix.com

Apply formatting fixes

Writes the suggested values of the records named, or of every issue of the property, as console edits.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
property requiredpathstringThe property's name
Idempotency-KeyheaderstringUp 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

JSON
{
  "object": "string",
  "groupType?": "string",
  "rule?": "string | null",
  "subjects?": []
}

Responses

Apply formatting fixes

JSON
{
  "applied": "integer"
}

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":[]}'
GET/v1/projects/{projectId}/crm/data-quality/countshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company

Responses

Count the data quality lists

JSON
{
  "refused": "integer",
  "undefined": "integer",
  "formatting": "integer",
  "duplicates": "integer",
  "health": "integer"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/data-quality/counts" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/data-quality/healthhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
object requiredquerystringperson or company
groupTypequerystringThe company type, for object company

Responses

Read property health

JSON
{
  "properties": [
    {
      "property": "string",
      "held": "integer",
      "recent": "integer",
      "share": "number",
      "isDefined": "boolean"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/data-quality/health" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/formshttps://api.prodantix.com

List forms

The project's forms by name, archived ones left out.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the forms belong to

Responses

200 The forms

JSON
{
  "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"
POST/v1/projects/{projectId}/formshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the forms belong to
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string",
  "definition": "unknown"
}

Responses

The draft

JSON
{
  "id": "string",
  "name": "string",
  "status": "string",
  "draft": "unknown",
  "publishedVersion?": "integer | null",
  "createdAt": "string",
  "updatedAt": "string"
}

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"}'
GET/v1/projects/{projectId}/forms/{formId}https://api.prodantix.com

Read a form

The form with its draft and its published version.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the forms belong to
formId requiredpathstringThe form

Responses

The form

JSON
{
  "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/:formId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/forms/{formId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the forms belong to
formId requiredpathstringThe form

Body

JSON
{
  "name": "string",
  "definition": "unknown"
}

Responses

The form

JSON
{
  "id": "string",
  "name": "string",
  "status": "string",
  "draft": "unknown",
  "publishedVersion?": "integer | null",
  "createdAt": "string",
  "updatedAt": "string"
}

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"}'
POST/v1/projects/{projectId}/forms/{formId}/publishhttps://api.prodantix.com

Publish a form

Freezes the draft as the next version and serves it. Needs prodantix.forms.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the forms belong to
formId requiredpathstringThe form
Idempotency-KeyheaderstringUp 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

JSON
{
  "id": "string",
  "name": "string",
  "status": "string",
  "draft": "unknown",
  "publishedVersion?": "integer | null",
  "createdAt": "string",
  "updatedAt": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/forms/:formId/publish" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/forms/{formId}/archivehttps://api.prodantix.com

Archive a form

It stops taking responses; its submissions stay. Needs prodantix.forms.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the forms belong to
formId requiredpathstringThe form
Idempotency-KeyheaderstringUp 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

JSON
{
  "id": "string",
  "name": "string",
  "status": "string",
  "draft": "unknown",
  "publishedVersion?": "integer | null",
  "createdAt": "string",
  "updatedAt": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/forms/:formId/archive" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/forms/{formId}/submissionshttps://api.prodantix.com

List a form's submissions

Newest first, a page at a time.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the forms belong to
formId requiredpathstringThe form
limitquerystringAt most this many, up to 500
beforequerystringOnly submissions before this time

Responses

200 The submissions

JSON
{
  "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"
GET/v1/projects/{projectId}/forms/{formId}/analyticshttps://api.prodantix.com

Read a form's numbers

Views, starts, submissions and conversion by day.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the forms belong to
formId requiredpathstringThe form
daysquerystringThe days counted back from today, up to 365

Responses

200 The days

JSON
{
  "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"
DELETE/v1/projects/{projectId}/form-submissions/{submissionId}https://api.prodantix.com

Delete a submission

Needs prodantix.forms.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the forms belong to
submissionId requiredpathstringThe submission

Responses

Deleted

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/form-submissions/:submissionId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/form-totalshttps://api.prodantix.com

Read every form's numbers

Each form's views, starts, submissions and conversion over the last days, for the forms list.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the forms belong to
daysquerystringThe days counted back from today, up to 365

Responses

200 The forms' numbers

JSON
{
  "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"
GET/v1/projects/{projectId}/ctashttps://api.prodantix.com

List CTAs

The project's CTAs by name, archived ones left out.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the CTAs belong to

Responses

200 The CTAs

JSON
{
  "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"
POST/v1/projects/{projectId}/ctashttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the CTAs belong to
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string",
  "definition": "unknown"
}

Responses

The draft

JSON
{
  "id": "string",
  "name": "string",
  "kind": "string",
  "status": "string",
  "draft": "unknown",
  "publishedVersion?": "integer | null",
  "createdAt": "string",
  "updatedAt": "string"
}

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"}'
GET/v1/projects/{projectId}/ctas/{ctaId}https://api.prodantix.com

Read a CTA

The CTA with its draft and its published version.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the CTAs belong to
ctaId requiredpathstringThe CTA

Responses

The CTA

JSON
{
  "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/:ctaId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/ctas/{ctaId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the CTAs belong to
ctaId requiredpathstringThe CTA

Body

JSON
{
  "name": "string",
  "definition": "unknown"
}

Responses

The CTA

JSON
{
  "id": "string",
  "name": "string",
  "kind": "string",
  "status": "string",
  "draft": "unknown",
  "publishedVersion?": "integer | null",
  "createdAt": "string",
  "updatedAt": "string"
}

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"}'
POST/v1/projects/{projectId}/ctas/{ctaId}/publishhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the CTAs belong to
ctaId requiredpathstringThe CTA
Idempotency-KeyheaderstringUp 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

JSON
{
  "id": "string",
  "name": "string",
  "kind": "string",
  "status": "string",
  "draft": "unknown",
  "publishedVersion?": "integer | null",
  "createdAt": "string",
  "updatedAt": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/publish" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/ctas/{ctaId}/pausehttps://api.prodantix.com

Pause a CTA

Takes a live CTA off every page and frees its place under the plan. Needs prodantix.ctas.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the CTAs belong to
ctaId requiredpathstringThe CTA
Idempotency-KeyheaderstringUp 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

JSON
{
  "id": "string",
  "name": "string",
  "kind": "string",
  "status": "string",
  "draft": "unknown",
  "publishedVersion?": "integer | null",
  "createdAt": "string",
  "updatedAt": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/pause" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/ctas/{ctaId}/resumehttps://api.prodantix.com

Resume a CTA

Shows a paused CTA's published version again, in one of the plan's live places. Needs prodantix.ctas.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the CTAs belong to
ctaId requiredpathstringThe CTA
Idempotency-KeyheaderstringUp 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

JSON
{
  "id": "string",
  "name": "string",
  "kind": "string",
  "status": "string",
  "draft": "unknown",
  "publishedVersion?": "integer | null",
  "createdAt": "string",
  "updatedAt": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/resume" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/ctas/{ctaId}/archivehttps://api.prodantix.com

Archive a CTA

It leaves every page and the list; its events stay. Needs prodantix.ctas.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the CTAs belong to
ctaId requiredpathstringThe CTA
Idempotency-KeyheaderstringUp 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

JSON
{
  "id": "string",
  "name": "string",
  "kind": "string",
  "status": "string",
  "draft": "unknown",
  "publishedVersion?": "integer | null",
  "createdAt": "string",
  "updatedAt": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/archive" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/ctas/{ctaId}/reporthttps://api.prodantix.com

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%.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the CTAs belong to
ctaId requiredpathstringThe CTA
daysquerystringThe days counted back from today, up to 365

Responses

The report

JSON
{
  "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"
  }
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/ctas/:ctaId/report" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/cta-totalshttps://api.prodantix.com

Read every CTA's numbers

Each CTA's views, clicks, dismissals and click rate over the last days, for the CTA list.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the CTAs belong to
daysquerystringThe days counted back from today, up to 365

Responses

200 The CTAs' numbers

JSON
{
  "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"
GET/v1/projects/{projectId}/pageshttps://api.prodantix.com

List landing pages

The project's landing pages by name and language, archived ones left out.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the pages belong to

Responses

200 The pages

JSON
{
  "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"
POST/v1/projects/{projectId}/pageshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the pages belong to
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string",
  "address": {
    "domain?": "string | null",
    "path": "string",
    "language": "string"
  },
  "template?": "string | null",
  "translationOf?": "string | null",
  "definition": "unknown"
}

Responses

The draft

JSON
{
  "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 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"}'
GET/v1/projects/{projectId}/pages/{pageId}https://api.prodantix.com

Read a landing page

The page with its address, draft and published version.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the pages belong to
pageId requiredpathstringThe page

Responses

The page

JSON
{
  "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/:pageId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/pages/{pageId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the pages belong to
pageId requiredpathstringThe page

Body

JSON
{
  "name": "string",
  "address": {
    "domain?": "string | null",
    "path": "string",
    "language": "string"
  },
  "definition": "unknown"
}

Responses

The page

JSON
{
  "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 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"}'
POST/v1/projects/{projectId}/pages/{pageId}/publishhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the pages belong to
pageId requiredpathstringThe page
Idempotency-KeyheaderstringUp 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

JSON
{
  "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 POST "https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/publish" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/pages/{pageId}/unpublishhttps://api.prodantix.com

Take a landing page offline

The page answers 404 until it is published again, and keeps its address and versions. Needs prodantix.pages.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the pages belong to
pageId requiredpathstringThe page
Idempotency-KeyheaderstringUp 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

JSON
{
  "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 POST "https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/unpublish" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/pages/{pageId}/archivehttps://api.prodantix.com

Archive a landing page

It stops serving, frees its address and leaves the list; its events stay. Needs prodantix.pages.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the pages belong to
pageId requiredpathstringThe page
Idempotency-KeyheaderstringUp 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

JSON
{
  "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 POST "https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/archive" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/pages/{pageId}/reporthttps://api.prodantix.com

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%.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the pages belong to
pageId requiredpathstringThe page
daysquerystringThe days counted back from today, up to 365

Responses

The report

JSON
{
  "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"
  }
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/pages/:pageId/report" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/page-totalshttps://api.prodantix.com

Read every landing page's numbers

Each page's views, visitors and submissions over the last days, for the pages list.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the pages belong to
daysquerystringThe days counted back from today, up to 365

Responses

200 The pages' numbers

JSON
{
  "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"
GET/v1/projects/{projectId}/consent-bannerhttps://api.prodantix.com

The project's consent banner with its draft and published version, or null before one is saved. Needs prodantix.projects.read.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the banner belongs to

Responses

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/consent-banner" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/consent-bannerhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the banner belongs to

Body

JSON
{
  "definition": "unknown"
}

Responses

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"}'
POST/v1/projects/{projectId}/consent-banner/publishhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the banner belongs to
Idempotency-KeyheaderstringUp 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

JSON
{
  "id": "string",
  "status": "string",
  "draft": "unknown",
  "publishedVersion?": "integer | null",
  "geotargeting": "boolean",
  "updatedAt": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/consent-banner/publish" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/consent-banner/unpublishhttps://api.prodantix.com

Take the consent banner off

Stops showing the banner; its records stay. Needs prodantix.projects.update.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the banner belongs to
Idempotency-KeyheaderstringUp 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

JSON
{
  "id": "string",
  "status": "string",
  "draft": "unknown",
  "publishedVersion?": "integer | null",
  "geotargeting": "boolean",
  "updatedAt": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/consent-banner/unpublish" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/people/{distinctId}/consentshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the banner belongs to
distinctId requiredpathstringThe person

Responses

200 The records

JSON
{
  "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"
POST/v1/projects/{projectId}/erasureshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the end user belongs to
Idempotency-KeyheaderstringUp 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

JSON
{
  "distinctId": "string",
  "callbackUrl?": "string | null"
}

Responses

The erasure job

JSON
{
  "id": "string",
  "projectId": "string",
  "status": "string",
  "counts": "unknown",
  "requestedAt": "string",
  "finishedAt?": "string | null"
}

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"}'
GET/v1/projects/{projectId}/erasures/{erasureId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the erasure ran in
erasureId requiredpathstringThe id the erase request answered

Responses

The erasure job

JSON
{
  "id": "string",
  "projectId": "string",
  "status": "string",
  "counts": "unknown",
  "requestedAt": "string",
  "finishedAt?": "string | null"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/erasures/:erasureId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/exports/peoplehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the end user belongs to
Idempotency-KeyheaderstringUp 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

JSON
{
  "distinctId": "string",
  "callbackUrl?": "string | null"
}

Responses

The export

JSON
{
  "id": "string",
  "projectId": "string",
  "status": "string",
  "bytes?": "integer | null",
  "failure?": "string | null",
  "requestedAt": "string",
  "readyAt?": "string | null",
  "expiresAt?": "string | null"
}

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"}'
GET/v1/projects/{projectId}/exports/people/{exportId}https://api.prodantix.com

Read an end-user export

Where an export stands: queued, building, ready (with its size and when it is deleted), failed or expired.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the export ran in
exportId requiredpathstringThe id the export request answered

Responses

The export

JSON
{
  "id": "string",
  "projectId": "string",
  "status": "string",
  "bytes?": "integer | null",
  "failure?": "string | null",
  "requestedAt": "string",
  "readyAt?": "string | null",
  "expiresAt?": "string | null"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/exports/people/:exportId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/exports/people/{exportId}/linkhttps://api.prodantix.com

Link to an end-user export

A link that downloads the ready archive, valid for a minute.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the export ran in
exportId requiredpathstringThe id the export request answered
Idempotency-KeyheaderstringUp 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

JSON
{
  "url": "string",
  "expiresInSeconds": "integer"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/exports/people/:exportId/link" \
  -H "Authorization: Bearer $BEARER_AUTH"

deals

GET/v1/projects/{projectId}/crm/pipelineshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Responses

List pipelines

JSON
{
  "pipelines": [
    {
      "id": "string",
      "name": "string",
      "position": "integer",
      "stages": [
        {
          "id": "string",
          "name": "string",
          "position": "integer",
          "probability": "integer",
          "kind": "string",
          "deals": "integer"
        }
      ]
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/pipelines" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/pipelineshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string",
  "stages": [
    {
      "id?": "string | null",
      "name": "string",
      "probability": "integer",
      "kind": "string"
    }
  ]
}

Responses

Create a pipeline

JSON
{
  "id": "string"
}

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":[]}'
PATCH/v1/projects/{projectId}/crm/pipelines/{pipelineId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
pipelineId requiredpathstringThe pipeline
Idempotency-KeyheaderstringUp 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

JSON
{
  "name?": "string | null",
  "stages?": [
    {
      "id?": "string | null",
      "name": "string",
      "probability": "integer",
      "kind": "string"
    }
  ]
}

Responses

Change a pipeline

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":[]}'
DELETE/v1/projects/{projectId}/crm/pipelines/{pipelineId}https://api.prodantix.com

Delete a pipeline

Removes the pipeline, its deals moved first to a stage of another pipeline; a project keeps one pipeline.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
pipelineId requiredpathstringThe pipeline
moveToquerystringThe stage its deals move to, when it holds any

Responses

Delete a pipeline

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/pipelines/:pipelineId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/crm/pipelines/orderhttps://api.prodantix.com

Order pipelines

Puts the project's pipelines in the order given.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Body

JSON
{
  "pipelineIds": []
}

Responses

Order pipelines

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":[]}'
DELETE/v1/projects/{projectId}/crm/pipeline-stages/{stageId}https://api.prodantix.com

Delete a stage

Removes the stage, its deals moved first to another stage of the same pipeline.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
stageId requiredpathstringThe stage
moveToquerystringThe stage its deals move to, when it holds any

Responses

Delete a stage

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/pipeline-stages/:stageId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/crm/reporting-currencyhttps://api.prodantix.com

Read the reporting currency

The currency deal reports convert into.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Responses

Read the reporting currency

JSON
{
  "currency": "string"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/reporting-currency" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/crm/reporting-currencyhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Body

JSON
{
  "currency": "string"
}

Responses

Change the reporting currency

JSON
{
  "currency": "string"
}

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"}'
GET/v1/projects/{projectId}/crm/dealshttps://api.prodantix.com

List deals

Deals newest first, optionally of one pipeline, stage or owner, or by name, after a cursor.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
pipelineIdquerystringOnly this pipeline's deals
stageIdquerystringOnly this stage's deals
ownerquerystringOnly this owner's deals
searchquerystringDeals whose name contains this
afterUpdatedAtquerystringThe cursor's time
afterIdquerystringThe cursor's deal
limitquerystringAt most this many, up to 500

Responses

List deals

JSON
{
  "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"
        }
      ]
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/deals" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/dealshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
    }
  ]
}

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":[]}'
GET/v1/projects/{projectId}/crm/deals/{dealId}https://api.prodantix.com

Read a deal

One deal with its people and companies.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
dealId requiredpathstringThe deal

Responses

Read a deal

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PATCH/v1/projects/{projectId}/crm/deals/{dealId}https://api.prodantix.com

Change a deal

Writes the fields named; custom properties merge and a null clears one.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
dealId requiredpathstringThe deal
Idempotency-KeyheaderstringUp 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

JSON
{
  "name?": "string | null",
  "amount?": "string | null",
  "currency?": "string | null",
  "closeDate?": "string | null",
  "owner?": "string | null",
  "lostReason?": "string | null",
  "properties?": "unknown"
}

Responses

Change a deal

JSON
{
  "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"
    }
  ]
}

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"}'
DELETE/v1/projects/{projectId}/crm/deals/{dealId}https://api.prodantix.com

Delete a deal

Removes the deal with its associations and history.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
dealId requiredpathstringThe deal

Responses

Delete a deal

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/crm/deals/:dealId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/crm/deals/{dealId}/movehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
dealId requiredpathstringThe deal
Idempotency-KeyheaderstringUp 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

JSON
{
  "pipelineId": "string",
  "stageId": "string",
  "lostReason?": "string | null"
}

Responses

Move a deal

JSON
{
  "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"
    }
  ]
}

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"}'
POST/v1/projects/{projectId}/crm/deals/{dealId}/recordshttps://api.prodantix.com

Associate a record

Associates a person or a company with the deal; the deal's first company is primary.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
dealId requiredpathstringThe deal
Idempotency-KeyheaderstringUp 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

JSON
{
  "object": "string",
  "groupType?": "string",
  "subject": "string"
}

Responses

Associate a record

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"}'
DELETE/v1/projects/{projectId}/crm/deals/{dealId}/recordshttps://api.prodantix.com

Dissociate a record

Removes the association; removing the primary company promotes the earliest other.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
dealId requiredpathstringThe deal

Body

JSON
{
  "object": "string",
  "groupType?": "string",
  "subject": "string"
}

Responses

Dissociate a record

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"}'
POST/v1/projects/{projectId}/crm/deals/{dealId}/primaryhttps://api.prodantix.com

Make a company primary

Marks one of the deal's companies primary.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
dealId requiredpathstringThe deal
Idempotency-KeyheaderstringUp 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

JSON
{
  "groupType": "string",
  "groupKey": "string"
}

Responses

Make a company primary

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"}'
GET/v1/projects/{projectId}/crm/deal-reportshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
pipelineId requiredquerystringThe pipeline
ownerquerystringOnly this owner's deals
sincequerystringClosed deals and moves from this RFC 3339 time; 90 days back by default

Responses

Read deal reports

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/crm/deal-reports" \
  -H "Authorization: Bearer $BEARER_AUTH"

messenger

GET/v1/projects/{projectId}/messenger/help-centrehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project whose messenger this is

Responses

The help centre and the project's article search

JSON
{
  "site?": {
    "url": "string",
    "articles": "integer",
    "languages": [],
    "lastReadAt?": "string | null",
    "readError?": "string | null",
    "capped": "boolean"
  },
  "search": {
    "on": "boolean",
    "placement": "tab | first_view | while_typing"
  }
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/messenger/help-centre/refreshhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project whose messenger this is
Idempotency-KeyheaderstringUp 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

JSON
{
  "site?": {
    "url": "string",
    "articles": "integer",
    "languages": [],
    "lastReadAt?": "string | null",
    "readError?": "string | null",
    "capped": "boolean"
  },
  "search": {
    "on": "boolean",
    "placement": "tab | first_view | while_typing"
  }
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/refresh" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/messenger/article-searchhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project whose messenger this is

Body

JSON
{
  "on": "boolean",
  "placement": "tab | first_view | while_typing"
}

Responses

The article search as stored

JSON
{
  "on": "boolean",
  "placement": "tab | first_view | while_typing"
}

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"}'
GET/v1/projects/{projectId}/messenger/help-centre/articleshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project whose messenger this is
from requiredquerystringAn RFC 3339 time; the range includes from and excludes to.
to requiredquerystringAn RFC 3339 time; the range includes from and excludes to.

Responses

The articles

JSON
[
  {
    "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"
  }
]

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/articles" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/messenger/help-centre/gapshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project whose messenger this is

Responses

The latest grouping

JSON
{
  "computedAt?": "string | null",
  "grouped": "boolean",
  "topics": [
    {
      "title?": "string | null",
      "questions": [],
      "conversations": "integer"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/messenger/help-centre/gaps" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/messenger/translationshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project whose messenger this is
Idempotency-KeyheaderstringUp 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

JSON
{
  "from": "string",
  "to": "string",
  "texts": []
}

Responses

One translation per text, in order

JSON
{
  "texts": []
}

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":[]}'
GET/v1/messenger/confighttps://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
localequerystringBCP 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.

Responses

The messenger configuration, or a disabled marker

JSON
{
  "enabled": "boolean",
  "launcherPosition": "string",
  "launcherOffsetX": "integer",
  "launcherOffsetY": "integer",
  "accentColor": "string",
  "onAccent": "string",
  "accentInk": "string",
  "accentInkDark": "string",
  "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"
    }
  },
  "whiteLabel": "boolean",
  "poweredBy?": "string | null"
}

Try it

curl -X GET "https://api.prodantix.com/v1/messenger/config" \
  -H "Authorization: Bearer $PROJECT_KEY"
GET/v1/messenger/avatar/{user_id}/{file}https://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
user_id requiredpathstringThe person the picture belongs to.
file requiredpathstringThe picture's content hash and extension.
api_keyquerystringThe public project key, for a load that cannot set the bearer header.

Responses

The picture, as PNG, JPEG, WebP or SVG

Try it

curl -X GET "https://api.prodantix.com/v1/messenger/avatar/:user_id/:file" \
  -H "Authorization: Bearer $PROJECT_KEY"
GET/v1/messenger/articleshttps://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
qquerystringThe words to search for.
collectionquerystringA top-level collection's title, as the collections read names it, to list its articles instead.
langquerystringThe visitor's language as a BCP 47 tag. Articles in its primary subtag come first, then the help centre's own default language.
user_idquerystringThe signed-in visitor's id, sent with user_hash. A verified pair also answers the articles kept for signed-in readers.
user_hashquerystringHMAC-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

JSON
{
  "articles": [
    {
      "id": "string",
      "title": "string",
      "trail": [],
      "url": "string",
      "embedUrl": "string",
      "pageId": "string",
      "language": "string"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/messenger/articles" \
  -H "Authorization: Bearer $PROJECT_KEY"
GET/v1/messenger/articles/popularhttps://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
langquerystringThe visitor's language as a BCP 47 tag. Articles in its primary subtag come first, then the help centre's own default language.
user_idquerystringThe signed-in visitor's id, sent with user_hash. A verified pair also answers the articles kept for signed-in readers.
user_hashquerystringHMAC-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

Try it

curl -X GET "https://api.prodantix.com/v1/messenger/articles/popular" \
  -H "Authorization: Bearer $PROJECT_KEY"
GET/v1/messenger/articles/collectionshttps://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
langquerystringThe visitor's language as a BCP 47 tag. Articles in its primary subtag come first, then the help centre's own default language.
user_idquerystringThe signed-in visitor's id, sent with user_hash. A verified pair also answers the articles kept for signed-in readers.
user_hashquerystringHMAC-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

JSON
{
  "collections": [
    {
      "title": "string",
      "articles": "integer"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/messenger/articles/collections" \
  -H "Authorization: Bearer $PROJECT_KEY"
GET/v1/messenger/articles/{pageId}/framehttps://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
pageId requiredpathstringThe article's page id, as the article reads name it.
langquerystringThe visitor's language as a BCP 47 tag. Articles in its primary subtag come first, then the help centre's own default language.
user_idquerystringThe signed-in visitor's id, sent with user_hash. A verified pair also answers the articles kept for signed-in readers.
user_hashquerystringHMAC-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

JSON
{
  "url": "string"
}

Try it

curl -X GET "https://api.prodantix.com/v1/messenger/articles/:pageId/frame" \
  -H "Authorization: Bearer $PROJECT_KEY"
POST/v1/messenger/articles/{pageId}/reactionhttps://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
pageId requiredpathstringThe help centre page, by the id the article reads answered.

Body

JSON
{
  "distinctId": "string",
  "language": "string",
  "reaction": "string"
}

Responses

Recorded

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"}'
POST/v1/messenger/articles/{pageId}/openedhttps://api.prodantix.com

Count a help article read in the messenger

Counts one opening of a help article in the messenger's reader, for the article report.

Auth projectKey

Parameters

NameInTypeDescription
pageId requiredpathstringThe help centre page, by the id the article reads answered.

Body

JSON
{
  "language": "string",
  "distinctId?": "string | null"
}

Responses

Recorded

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"}'

company

GET/v1/company/ssohttps://api.prodantix.com

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.

Auth bearerAuth

Responses

The connection

JSON
{
  "id": "string",
  "protocol": "string",
  "displayName": "string",
  "issuer?": "string | null",
  "clientId?": "string | null",
  "createdAt": "string",
  "updatedAt": "string"
}

Try it

curl -X GET "https://api.prodantix.com/v1/company/sso" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/company/ssohttps://api.prodantix.com

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.

Auth bearerAuth

Body

JSON
{
  "displayName": "string",
  "protocol": "string",
  "issuer?": "string | null",
  "clientId?": "string | null",
  "clientSecret?": "string | null",
  "metadataXml?": "string | null"
}

Responses

The connection as stored

JSON
{
  "id": "string",
  "protocol": "string",
  "displayName": "string",
  "issuer?": "string | null",
  "clientId?": "string | null",
  "createdAt": "string",
  "updatedAt": "string"
}

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"}'
DELETE/v1/company/ssohttps://api.prodantix.com

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.

Auth bearerAuth

Responses

The provider is disconnected

Try it

curl -X DELETE "https://api.prodantix.com/v1/company/sso" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/company/closurehttps://api.prodantix.com

Read the company's closure

When the company closed, why, and when it is deleted; `closure` is null while it is open.

Auth bearerAuth

Responses

200 The closure

JSON
{
  "closure?": {
    "closedAt": "string",
    "purgeAfter": "string",
    "reason": "string"
  }
}

Try it

curl -X GET "https://api.prodantix.com/v1/company/closure" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/company/closehttps://api.prodantix.com

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`.

Auth bearerAuth

Parameters

NameInTypeDescription
Idempotency-KeyheaderstringUp 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

JSON
{
  "closedAt": "string",
  "purgeAfter": "string",
  "reason": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/company/close" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/company/reopenhttps://api.prodantix.com

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`.

Auth bearerAuth

Parameters

NameInTypeDescription
Idempotency-KeyheaderstringUp 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

Try it

curl -X POST "https://api.prodantix.com/v1/company/reopen" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/company/exporthttps://api.prodantix.com

Read the company's export

The latest export of everything, or null when none was asked for. Owners only.

Auth bearerAuth

Responses

The export

JSON
{
  "export?": {
    "id": "string",
    "status": "string",
    "bytes?": "integer | null",
    "requestedAt": "string",
    "readyAt?": "string | null",
    "expiresAt?": "string | null"
  }
}

Try it

curl -X GET "https://api.prodantix.com/v1/company/export" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/company/exporthttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
Idempotency-KeyheaderstringUp 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

JSON
{
  "id": "string",
  "status": "string",
  "bytes?": "integer | null",
  "requestedAt": "string",
  "readyAt?": "string | null",
  "expiresAt?": "string | null"
}

Try it

curl -X POST "https://api.prodantix.com/v1/company/export" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/company/export/{exportId}/linkhttps://api.prodantix.com

Link to the company's export

A link that downloads the ready archive, valid for a minute. Owners only.

Auth bearerAuth

Parameters

NameInTypeDescription
exportId requiredpathstringThe id the export request answered
Idempotency-KeyheaderstringUp 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

JSON
{
  "url": "string",
  "expiresInSeconds": "integer"
}

Try it

curl -X POST "https://api.prodantix.com/v1/company/export/:exportId/link" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/domainshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project environment the domains belong to

Responses

200 The domains

JSON
{
  "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"
POST/v1/projects/{projectId}/domainshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project environment the domains belong to
Idempotency-KeyheaderstringUp 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

JSON
{
  "domain": "string",
  "purpose": "string"
}

Responses

The claimed domain

JSON
{
  "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"
}

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"}'
POST/v1/projects/{projectId}/domains/{domainId}/checkhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project environment the domains belong to
domainId requiredpathstringThe domain's id
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/domains/:domainId/check" \
  -H "Authorization: Bearer $BEARER_AUTH"
DELETE/v1/projects/{projectId}/domains/{domainId}https://api.prodantix.com

Remove a domain

The domain stops serving at once and is detached at the next pipeline run. Needs prodantix.projects.update.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project environment the domains belong to
domainId requiredpathstringThe domain's id

Responses

The removed domain

JSON
{
  "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"
}

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/domains/:domainId" \
  -H "Authorization: Bearer $BEARER_AUTH"

surveys

GET/v1/projects/{projectId}/surveyshttps://api.prodantix.com

List surveys

A project's surveys that are not archived, most recently changed first.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the survey belongs to.

Responses

The surveys

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/surveys" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/surveyshttps://api.prodantix.com

Create a survey

Saves a draft survey: its questions, appearance, targeting and schedule.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the survey belongs to.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
}

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"}'
GET/v1/projects/{projectId}/surveys/{surveyId}https://api.prodantix.com

Read a survey

One survey with its questions, appearance, targeting and schedule.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the survey belongs to.
surveyId requiredpathstringThe survey.

Responses

The survey

JSON
{
  "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"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/surveys/{surveyId}https://api.prodantix.com

Change a survey

Replaces a survey's name, questions, appearance, targeting and schedule.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the survey belongs to.
surveyId requiredpathstringThe survey.

Body

JSON
{
  "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

JSON
{
  "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"
}

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"}'
POST/v1/projects/{projectId}/surveys/{surveyId}/starthttps://api.prodantix.com

Start a survey

Shows the survey to the visitors it targets from its start time.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the survey belongs to.
surveyId requiredpathstringThe survey.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/start" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/surveys/{surveyId}/stophttps://api.prodantix.com

Stop a survey

Stops showing the survey; its results stay.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the survey belongs to.
surveyId requiredpathstringThe survey.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/stop" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/surveys/{surveyId}/archivehttps://api.prodantix.com

Archive a survey

Removes the survey from the list; its results stay in the events.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the survey belongs to.
surveyId requiredpathstringThe survey.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/archive" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/surveys/{surveyId}/duplicatehttps://api.prodantix.com

Duplicate a survey

Saves a draft copy of a survey.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the survey belongs to.
surveyId requiredpathstringThe survey.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/duplicate" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/surveys/{surveyId}/resultshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the survey belongs to.
surveyId requiredpathstringThe survey.
iterationqueryintegerThe round to read.

Responses

The results

JSON
{
  "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": []
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/surveys/:surveyId/results" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/surveys/responseshttps://api.prodantix.com

Count each survey's responses

How many answers each of the project's surveys has received, over every round.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the survey belongs to.

Responses

The counts, one per survey with any response

JSON
{
  "surveys": [
    {
      "surveyId": "string",
      "responses": "integer"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/surveys/responses" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/surveys/translationshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the survey belongs to.
Idempotency-KeyheaderstringUp 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

JSON
{
  "from": "string",
  "to": "string",
  "texts": []
}

Responses

One translation per text, in order

JSON
{
  "texts": []
}

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":[]}'
GET/v1/surveyshttps://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
distinct_id requiredquerystringThe visitor's distinct id.
langquerystringThe 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

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/surveys" \
  -H "Authorization: Bearer $PROJECT_KEY"

tickets

GET/v1/projects/{projectId}/ticketshttps://api.prodantix.com

List tickets

A project's tickets, newest number first, filtered by state category, type, assignee, person, tracker or words in the title or number. Pages back with `before`, a ticket number.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
statequerystringA state category: submitted, in_progress, waiting_on_customer or resolved.
typeIdquerystringA ticket type's id.
assigneequerystringA member's id.
distinctIdquerystringThe person's distinct id.
trackerIdquerystringA tracker ticket's id, to list the customer tickets linked to it.
qquerystringWords in the title, or a ticket number.
beforequerystringList tickets numbered below this one.
limitquerystringAt most this many, up to 100. 50 when left out.

Responses

The tickets

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/tickets" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/ticketshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
}

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":{}}'
GET/v1/projects/{projectId}/tickets/{ticketId}https://api.prodantix.com

Read a ticket

One ticket by its id or its number.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
ticketId requiredpathstringThe ticket's id, or its number.

Responses

The ticket

JSON
{
  "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"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PATCH/v1/projects/{projectId}/tickets/{ticketId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
ticketId requiredpathstringThe ticket's id, or its number.
Idempotency-KeyheaderstringUp 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

JSON
{
  "title?": "string | null",
  "priority?": "Priority | null",
  "stateId?": "string | null",
  "assigneeUserId?": "string | null",
  "unassign?": "boolean",
  "attributes?": "object | null"
}

Responses

The ticket as saved

JSON
{
  "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"
}

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":{}}'
GET/v1/projects/{projectId}/tickets/{ticketId}/noteshttps://api.prodantix.com

Read a ticket's timeline

A ticket's internal notes and the changes made to it, oldest first. Never shown to the customer.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
ticketId requiredpathstringThe ticket's id, or its number.

Responses

The timeline

JSON
{
  "notes": [
    {
      "id": "string",
      "kind": "string",
      "authorKind": "string",
      "authorId?": "string | null",
      "body?": "string | null",
      "data": "unknown",
      "createdAt": "string"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/tickets/:ticketId/notes" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/tickets/{ticketId}/noteshttps://api.prodantix.com

Add a note to a ticket

Adds an internal note to a ticket's timeline.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
ticketId requiredpathstringThe ticket's id, or its number.
Idempotency-KeyheaderstringUp 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

JSON
{
  "body": "string"
}

Responses

The note

JSON
{
  "id": "string",
  "kind": "string",
  "authorKind": "string",
  "authorId?": "string | null",
  "body?": "string | null",
  "data": "unknown",
  "createdAt": "string"
}

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"}'
PUT/v1/projects/{projectId}/tickets/{ticketId}/trackerhttps://api.prodantix.com

Link a ticket to a tracker

Links a customer ticket to a tracker ticket, or unlinks it with a null trackerId.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
ticketId requiredpathstringThe ticket's id, or its number.

Body

JSON
{
  "trackerId?": "string | null"
}

Responses

The ticket as saved

JSON
{
  "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"
}

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"}'
POST/v1/projects/{projectId}/tickets/{ticketId}/mergehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
ticketId requiredpathstringThe ticket's id, or its number.
Idempotency-KeyheaderstringUp 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

JSON
{
  "into": "string"
}

Responses

The ticket merged into

JSON
{
  "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"
}

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"}'
GET/v1/projects/{projectId}/ticket-typeshttps://api.prodantix.com

List ticket types

A project's ticket types with their attributes, by name. Archived types only when `archived` is true.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
archivedquerystringtrue to include archived types.

Responses

The ticket types

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/ticket-types" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/ticket-typeshttps://api.prodantix.com

Create a ticket type

A customer, back-office or tracker ticket type with its attributes.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
}

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":[]}'
PUT/v1/projects/{projectId}/ticket-types/{typeId}https://api.prodantix.com

Change a ticket type

Replaces a ticket type's name, description, form and attributes. A type that holds tickets keeps its category.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
typeId requiredpathstringThe ticket type's id.

Body

JSON
{
  "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

JSON
{
  "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"
}

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":[]}'
POST/v1/projects/{projectId}/ticket-types/{typeId}/archivehttps://api.prodantix.com

Archive or restore a ticket type

An archived type takes no new tickets; its tickets stay.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
typeId requiredpathstringThe ticket type's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "archived": "boolean"
}

Responses

The ticket type as saved

JSON
{
  "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"
}

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}'
GET/v1/projects/{projectId}/ticket-stateshttps://api.prodantix.com

List ticket states

A project's ticket states in order, each with its customer label and category. A project starts with one per category.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The states

JSON
{
  "states": [
    {
      "id": "string",
      "name": "string",
      "customerLabel": "string",
      "category": "submitted | in_progress | waiting_on_customer | resolved",
      "position": "integer",
      "ticketCount": "integer"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/ticket-states" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/ticket-stateshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Body

JSON
{
  "states": [
    {
      "id?": "string | null",
      "name": "string",
      "customerLabel": "string",
      "category": "submitted | in_progress | waiting_on_customer | resolved"
    }
  ]
}

Responses

The states as saved

JSON
{
  "states": [
    {
      "id": "string",
      "name": "string",
      "customerLabel": "string",
      "category": "submitted | in_progress | waiting_on_customer | resolved",
      "position": "integer",
      "ticketCount": "integer"
    }
  ]
}

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":[]}'
GET/v1/projects/{projectId}/sla-policieshttps://api.prodantix.com

List SLA policies

A project's service level policies with their targets in minutes.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The policies

JSON
{
  "policies": [
    {
      "id": "string",
      "name": "string",
      "hours": "office | always",
      "firstResponseMinutes?": "integer | null",
      "nextResponseMinutes?": "integer | null",
      "closeMinutes?": "integer | null",
      "resolveMinutes?": "integer | null",
      "updatedAt": "string"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/sla-policies" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/sla-policieshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string",
  "hours": "office | always",
  "firstResponseMinutes?": "integer | null",
  "nextResponseMinutes?": "integer | null",
  "closeMinutes?": "integer | null",
  "resolveMinutes?": "integer | null"
}

Responses

The policy as saved

JSON
{
  "id": "string",
  "name": "string",
  "hours": "office | always",
  "firstResponseMinutes?": "integer | null",
  "nextResponseMinutes?": "integer | null",
  "closeMinutes?": "integer | null",
  "resolveMinutes?": "integer | null",
  "updatedAt": "string"
}

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}'
PUT/v1/projects/{projectId}/sla-policies/{policyId}https://api.prodantix.com

Change an SLA policy

Replaces a policy's name, hours and targets. Clocks already running keep the targets they started with.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
policyId requiredpathstringThe SLA policy's id.

Body

JSON
{
  "name": "string",
  "hours": "office | always",
  "firstResponseMinutes?": "integer | null",
  "nextResponseMinutes?": "integer | null",
  "closeMinutes?": "integer | null",
  "resolveMinutes?": "integer | null"
}

Responses

The policy as saved

JSON
{
  "id": "string",
  "name": "string",
  "hours": "office | always",
  "firstResponseMinutes?": "integer | null",
  "nextResponseMinutes?": "integer | null",
  "closeMinutes?": "integer | null",
  "resolveMinutes?": "integer | null",
  "updatedAt": "string"
}

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}'
DELETE/v1/projects/{projectId}/sla-policies/{policyId}https://api.prodantix.com

Delete an SLA policy

Deletes a policy and the rules that choose it.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
policyId requiredpathstringThe SLA policy's id.

Responses

Deleted

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/sla-policies/:policyId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/sla-ruleshttps://api.prodantix.com

List SLA rules

The rules that choose a new conversation's or ticket's policy, in order, first match wins.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The rules

JSON
{
  "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"
        }
      ]
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/sla-rules" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/sla-ruleshttps://api.prodantix.com

Set SLA rules

Replaces the rules in order. Each names a policy, and may narrow by record kind, ticket type, priority and person properties.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Body

JSON
{
  "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

JSON
{
  "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"
        }
      ]
    }
  ]
}

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":[]}'
GET/v1/projects/{projectId}/sla-clockshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
recordKind requiredquerystringconversation or ticket.
recordId requiredquerystringThe conversation's or ticket's id.

Responses

The clocks

JSON
{
  "clocks": [
    {
      "target": "string",
      "targetSeconds": "integer",
      "spentSeconds": "integer",
      "startedAt": "string",
      "metAt?": "string | null",
      "breachedAt?": "string | null"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/sla-clocks" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/tickets/formshttps://api.prodantix.com

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.

Auth projectKey

Responses

The ticket forms

JSON
{
  "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"
        }
      ]
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/tickets/forms" \
  -H "Authorization: Bearer $PROJECT_KEY"
GET/v1/ticketshttps://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
user_idquerystringThe signed-in visitor's id, sent with user_hash.
user_hashquerystringHMAC-SHA256 of user_id under the project's signing secret, as the messenger's identify sends it.

Responses

The visitor's tickets

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/tickets" \
  -H "Authorization: Bearer $PROJECT_KEY"
POST/v1/ticketshttps://api.prodantix.com

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.

Auth projectKey

Body

JSON
{
  "typeId": "string",
  "title": "string",
  "attributes?": "object",
  "distinctId": "string",
  "userId": "string",
  "userHash": "string"
}

Responses

The ticket's number and its conversation

JSON
{
  "number": "integer",
  "conversation": {
    "conversationId": "string",
    "token": "string",
    "expiresInSeconds": "integer"
  }
}

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"}'
POST/v1/tickets/{number}/conversationhttps://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
number requiredpathintegerThe ticket's number in its project.

Body

JSON
{
  "userId": "string",
  "userHash": "string"
}

Responses

The ticket's conversation and a token for it

JSON
{
  "conversationId": "string",
  "token": "string",
  "expiresInSeconds": "integer"
}

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"}'

conversations

GET/v1/projects/{projectId}/conversationshttps://api.prodantix.com

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`.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
distinctIdquerystringOne person's threads, in every status.
statusquerystringopen, snoozed or resolved.
assignedToMequerystringtrue for the caller's threads.
flaggedquerystringtrue for flagged threads.
handedOverquerystringtrue for threads the assistant handed to the team.
heldAsSpamquerystringtrue for threads held as spam.
searchquerystringWords to match.
cursorLastTurnAtquerystringThe last row's lastTurnAt.
cursorIdquerystringThe last row's id.
limitquerystringAt most this many, up to 200. 50 when left out.

Responses

The conversations

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/conversations/{conversationId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
limitquerystringHow many turns, up to 500.
beforequerystringA turn's id, to read the turns before it.

Responses

The thread

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/conversations/{conversationId}/replieshttps://api.prodantix.com

Reply to a conversation

Sends the caller's reply at once and clears their draft. The person sees it in the messenger straight away.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "body": "string",
  "original?": {
    "body": "string",
    "language": "string",
    "translatedLanguage": "string"
  }
}

Responses

The reply as sent

JSON
{
  "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"
  }
}

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"}'
POST/v1/projects/{projectId}/conversations/{conversationId}/held-replieshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "body": "string",
  "original?": {
    "body": "string",
    "language": "string",
    "translatedLanguage": "string"
  }
}

Responses

The held reply

JSON
{
  "id": "string",
  "conversationId": "string",
  "sendAt": "string"
}

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"}'
DELETE/v1/projects/{projectId}/held-replies/{replyId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
replyId requiredpathstringThe held reply's id.

Responses

The reply's text

JSON
{
  "body?": "string | null"
}

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/held-replies/:replyId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/conversations/{conversationId}/assigneehttps://api.prodantix.com

Assign a conversation

Assigns the thread to the caller, or clears the assignment.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.

Body

JSON
{
  "toMe": "boolean",
  "memberSub?": "string | null"
}

Responses

The conversation

JSON
{
  "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"
}

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"}'
PUT/v1/projects/{projectId}/conversations/{conversationId}/statushttps://api.prodantix.com

Open, snooze or resolve a conversation

Moves the thread between open, snoozed and resolved. Snoozing needs `snoozedUntil`; the other statuses clear it.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.

Body

JSON
{
  "status": "string",
  "snoozedUntil?": "string | null"
}

Responses

The conversation

JSON
{
  "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"
}

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"}'
PUT/v1/projects/{projectId}/conversations/{conversationId}/flaghttps://api.prodantix.com

Flag a conversation

Sets or clears the flag on a thread, a mark for finding it again.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.

Body

JSON
{
  "flagged": "boolean"
}

Responses

The conversation

JSON
{
  "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"
}

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}'
POST/v1/projects/{projectId}/conversations/{conversationId}/not-spamhttps://api.prodantix.com

Release a conversation held as spam

Returns a thread held as spam to the inbox.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/not-spam" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/conversations/{conversationId}/priorityhttps://api.prodantix.com

Set a conversation's priority

Sets the thread's priority: low, normal, high or urgent.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.

Body

JSON
{
  "priority": "low | normal | high | urgent"
}

Responses

The conversation

JSON
{
  "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"
}

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"}'
PATCH/v1/projects/{projectId}/conversations/{conversationId}/attributeshttps://api.prodantix.com

Set a conversation's attributes

Sets values of the project's conversation attributes on the thread; a null value clears one.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "values": "object"
}

Responses

The conversation

JSON
{
  "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"
}

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":{}}'
GET/v1/projects/{projectId}/conversations/{conversationId}/drafthttps://api.prodantix.com

Read the caller's draft

The caller's unsent reply on the thread, kept as they typed it.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.

Responses

The draft

JSON
{
  "body?": "string | null"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/draft" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/conversations/{conversationId}/drafthttps://api.prodantix.com

Keep the caller's draft

Keeps the caller's unsent reply; an empty or null body clears it.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.

Body

JSON
{
  "body?": "string | null"
}

Responses

The draft as kept

JSON
{
  "body?": "string | null"
}

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"}'
POST/v1/projects/{projectId}/conversations/{conversationId}/readhttps://api.prodantix.com

Mark a conversation read

Clears the thread's unread mark for the team.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/read" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/conversations/{conversationId}/mergehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "into": "string"
}

Responses

The conversation merged into

JSON
{
  "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"
}

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"}'
GET/v1/projects/{projectId}/conversations/{conversationId}/duplicate-peoplehttps://api.prodantix.com

List people who may be the same person

Other people of the project who share this thread's person's email, at most ten.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.

Responses

Their distinct ids

JSON
{
  "distinctIds": [],
  "people": [
    {
      "distinctId": "string",
      "name?": "string | null",
      "email": "string",
      "matchedOn": []
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/duplicate-people" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/conversations/{conversationId}/duplicate-people/{distinctId}/dismissalhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
distinctId requiredpathstringThe other person's distinct id.
Idempotency-KeyheaderstringUp 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

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/duplicate-people/:distinctId/dismissal" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/conversations/{conversationId}/summaryhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "text": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/summary" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/conversations/{conversationId}/translationhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "text": "string",
  "language": "string",
  "turnId?": "string | null"
}

Responses

The translation

JSON
{
  "text": "string",
  "sourceLanguage?": "string | null"
}

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"}'
POST/v1/projects/{projectId}/conversations/{conversationId}/ai-drafthttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "text": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/ai-draft" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/conversations/{conversationId}/macros/{macroId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
macroId requiredpathstringThe macro's id.

Responses

The preview

JSON
{
  "body": "string",
  "missing": []
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/macros/:macroId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/conversations/{conversationId}/macros/{macroId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
macroId requiredpathstringThe macro's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/macros/:macroId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/conversation-countshttps://api.prodantix.com

Count the inbox

Open, unread, snoozed, resolved, the caller's own, flagged, handed over and held as spam, in one read.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The counts

JSON
{
  "open": "integer",
  "unread": "integer",
  "snoozed": "integer",
  "resolved": "integer",
  "mine": "integer",
  "flagged": "integer",
  "handedOver": "integer",
  "spam": "integer"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversation-counts" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/conversation-attributeshttps://api.prodantix.com

List conversation attributes

The attributes the project's conversations carry.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The attributes

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversation-attributes" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/conversation-attributeshttps://api.prodantix.com

Set conversation attributes

Replaces the attributes the project's conversations carry.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Body

JSON
{
  "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

JSON
{
  "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"
    }
  ]
}

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":[]}'
GET/v1/projects/{projectId}/slack-inbox-channelshttps://api.prodantix.com

List the Slack inbox channels

The Slack channels whose messages land in the project's inbox as conversations.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The channels

JSON
{
  "channels": [
    {
      "connectionId": "string",
      "teamId": "string",
      "channelId": "string",
      "createdAt": "string"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/slack-inbox-channelshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Body

JSON
{
  "connectionId": "string",
  "channelId": "string"
}

Responses

The channels

JSON
{
  "channels": [
    {
      "connectionId": "string",
      "teamId": "string",
      "channelId": "string",
      "createdAt": "string"
    }
  ]
}

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"}'
DELETE/v1/projects/{projectId}/slack-inbox-channels/{connectionId}/{channelId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
connectionId requiredpathstringThe Slack connection's id.
channelId requiredpathstringThe Slack channel's id.

Responses

The channels left

JSON
{
  "channels": [
    {
      "connectionId": "string",
      "teamId": "string",
      "channelId": "string",
      "createdAt": "string"
    }
  ]
}

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/slack-inbox-channels/:connectionId/:channelId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/whatsapp-templateshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The templates

JSON
{
  "templates": [
    {
      "sid": "string",
      "name": "string",
      "language": "string",
      "body": "string",
      "variables": []
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/whatsapp-templates" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/conversations/{conversationId}/whatsapp-templatehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "contentSid": "string",
  "variables?": "object"
}

Responses

The turn

JSON
{
  "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"
  }
}

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":{}}'
POST/v1/projects/{projectId}/support-reportshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "dashboardId": "string"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/support-reports" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/conversations/{conversationId}/participantshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.

Responses

The participants

JSON
{
  "participants": []
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/participants" \
  -H "Authorization: Bearer $BEARER_AUTH"
DELETE/v1/projects/{projectId}/conversations/{conversationId}/participants/{address}https://api.prodantix.com

Remove a participant

Takes one person off an email conversation's replies. Needs the permission to send messages.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe conversation's id.
address requiredpathstringThe participant's email address.

Responses

The participants left

JSON
{
  "participants": []
}

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/participants/:address" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/email-signaturehttps://api.prodantix.com

Read your email signature

The signature your email replies in this company end with; null when you have none.

Auth bearerAuth

Responses

The signature

JSON
{
  "signature?": "string | null"
}

Try it

curl -X GET "https://api.prodantix.com/v1/email-signature" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/email-signaturehttps://api.prodantix.com

Set your email signature

Sets the signature your email replies in this company end with, at most 1000 characters. An empty signature removes it.

Auth bearerAuth

Body

JSON
{
  "signature?": "string | null"
}

Responses

The signature

JSON
{
  "signature?": "string | null"
}

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"}'
GET/v1/projects/{projectId}/support-reply-fromhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The address

JSON
{
  "address?": "string | null"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/support-reply-from" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/support-reply-fromhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Body

JSON
{
  "address?": "string | null"
}

Responses

The address

JSON
{
  "address?": "string | null"
}

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"}'
GET/v1/projects/{projectId}/support-addresshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The address

JSON
{
  "address?": "string | null",
  "lastReceivedAt?": "string | null"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/support-address" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/inbox-assignmenthttps://api.prodantix.com

Read the assignment setup

How new conversations are assigned, and each member's limit and away mark.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The setup

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/inbox-assignment" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/inbox-assignmenthttps://api.prodantix.com

Choose how conversations are assigned

Manual, round robin (Growth and up) or balanced (Scale and up).

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Body

JSON
{
  "method": "manual | round_robin | balanced"
}

Responses

The method as saved

JSON
{
  "method": "manual | round_robin | balanced"
}

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"}'
PUT/v1/projects/{projectId}/inbox-assignment/members/{memberSub}https://api.prodantix.com

Limit a member's open conversations

Caps how many open conversations assignment hands one member; null lifts the cap. Scale and up.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
memberSub requiredpathstringThe member's identity.

Body

JSON
{
  "limit?": "integer | null"
}

Responses

The member's status

JSON
{
  "memberSub": "string",
  "away": "boolean",
  "assignmentLimit?": "integer | null"
}

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}'
PUT/v1/projects/{projectId}/inbox-assignment/mehttps://api.prodantix.com

Mark the caller away or back

Away takes no new assignments; with `returnOpen` the caller's open conversations go back to be assigned.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Body

JSON
{
  "away": "boolean",
  "returnOpen?": "boolean"
}

Responses

The caller's status

JSON
{
  "memberSub": "string",
  "away": "boolean",
  "assignmentLimit?": "integer | null"
}

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}'
GET/v1/projects/{projectId}/inbox-dashboardhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The dashboard

JSON
{
  "open": "integer",
  "unassigned": "integer",
  "awaitingReply": "integer",
  "longestWaitSeconds?": "integer | null",
  "medianFirstResponseSeconds?": "integer | null",
  "members": [
    {
      "userId": "string",
      "memberSub?": "string | null",
      "open": "integer",
      "awaitingReply": "integer",
      "away": "boolean"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/inbox-dashboard" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/inbox-viewshttps://api.prodantix.com

List saved views

The caller's own views and the shared ones, in the caller's order.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The views

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/inbox-views" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/inbox-viewshttps://api.prodantix.com

Save a view

Saves a view of the inbox. A shared view needs the permission to manage the messenger.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
}

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"}'
GET/v1/projects/{projectId}/inbox-view-countshttps://api.prodantix.com

Count each saved view

How many conversations each of the caller's saved views selects now.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The counts

JSON
{
  "counts": [
    {
      "viewId": "string",
      "count": "integer"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/inbox-view-counts" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/inbox-views/{viewId}https://api.prodantix.com

Change a saved view

Replaces a view's name, conditions and order.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
viewId requiredpathstringThe view's id.

Body

JSON
{
  "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

JSON
{
  "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"
}

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"}'
DELETE/v1/projects/{projectId}/inbox-views/{viewId}https://api.prodantix.com

Delete a saved view

Deletes a view.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
viewId requiredpathstringThe view's id.

Responses

The view is gone

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/inbox-views/{viewId}/conversationshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
viewId requiredpathstringThe view's id.
searchquerystringWords to match.
cursorquerystringThe nextCursor of the page before.
limitquerystringAt most this many, up to 200. 50 when left out.

Responses

The page

JSON
{
  "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"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/inbox-views/:viewId/conversations" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/inbox-view-orderhttps://api.prodantix.com

Order the caller's views

Sets the order the caller sees their views in. Views left out keep their place after the ones named.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Body

JSON
{
  "ids": []
}

Responses

The views in order

JSON
{
  "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"
    }
  ]
}

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":[]}'
GET/v1/projects/{projectId}/macroshttps://api.prodantix.com

List macros

The caller's own macros and the shared ones.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The macros

JSON
{
  "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"
      }
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/macros" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/macroshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
  }
}

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"}'
PUT/v1/projects/{projectId}/macros/{macroId}https://api.prodantix.com

Change a macro

Replaces a macro's name, reply and actions.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
macroId requiredpathstringThe macro's id.

Body

JSON
{
  "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

JSON
{
  "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"
  }
}

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"}'
DELETE/v1/projects/{projectId}/macros/{macroId}https://api.prodantix.com

Delete a macro

Deletes a macro.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
macroId requiredpathstringThe macro's id.

Responses

The macro is gone

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/macros/:macroId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/reply-undo-secondshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Responses

The window

JSON
{
  "seconds": "integer"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/reply-undo-seconds" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/reply-undo-secondshttps://api.prodantix.com

Set the caller's undo window

0 turns it off; otherwise 5, 10, 20 or 30 seconds.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.

Body

JSON
{
  "seconds": "integer"
}

Responses

The window as saved

JSON
{
  "seconds": "integer"
}

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}'
GET/v1/projects/{projectId}/conversations/{conversationId}/side-conversationshttps://api.prodantix.com

List side conversations

The side conversations beside one customer conversation, oldest first. Members only: the customer never sees them.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe customer conversation's id.

Responses

The side conversations

JSON
[
  {
    "id": "string",
    "conversationId": "string",
    "subject": "string",
    "status": "string",
    "startedBy": "string",
    "createdAt": "string",
    "participants": []
  }
]

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/conversations/:conversationId/side-conversations" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/conversations/{conversationId}/side-conversationshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
conversationId requiredpathstringThe customer conversation's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "subject": "string",
  "to": [],
  "body": "string"
}

Responses

The side conversation and its first message

JSON
{
  "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"
    }
  ]
}

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"}'
GET/v1/projects/{projectId}/side-conversations/{sideConversationId}https://api.prodantix.com

Read a side conversation

One side conversation with every message on it, oldest first.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
sideConversationId requiredpathstringThe side conversation's id.

Responses

The side conversation and its messages

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/side-conversations/:sideConversationId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/side-conversations/{sideConversationId}/messageshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
sideConversationId requiredpathstringThe side conversation's id.
Idempotency-KeyheaderstringUp 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

JSON
{
  "body": "string"
}

Responses

The side conversation and its messages

JSON
{
  "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"
    }
  ]
}

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"}'
PUT/v1/projects/{projectId}/side-conversations/{sideConversationId}/statushttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project's id.
sideConversationId requiredpathstringThe side conversation's id.

Body

JSON
{
  "status": "string"
}

Responses

The side conversation

JSON
{
  "id": "string",
  "conversationId": "string",
  "subject": "string",
  "status": "string",
  "startedBy": "string",
  "createdAt": "string",
  "participants": []
}

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"}'
POST/v1/conversationshttps://api.prodantix.com

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.

Auth projectKey

Body

JSON
{
  "distinctId": "string",
  "subject?": "string | null",
  "userId?": "string | null",
  "userHash?": "string | null",
  "fromArticle?": {
    "pageId": "string",
    "language": "string"
  }
}

Responses

The conversation and its token

JSON
{
  "conversationId": "string",
  "token": "string",
  "expiresInSeconds": "integer"
}

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"}'
POST/v1/conversations/{id}/turnshttps://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
id requiredpathstringThe conversation the token was minted for.

Body

JSON
{
  "body": "string",
  "pageContext?": {
    "host": "string",
    "path": "string",
    "title": "string"
  },
  "attachmentIds?": []
}

Responses

The appended turn

JSON
{
  "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"
      }
    ]
  }
}

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":[]}'
GET/v1/conversations/{id}https://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
id requiredpathstringThe conversation the token was minted for.
limitqueryintegerHow many of the latest turns to return: 100 by default, at most 500.
beforequerystringA turn id: returns the turns before it, for paging back through a long thread.

Responses

The conversation thread

JSON
{
  "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"
}

Try it

curl -X GET "https://api.prodantix.com/v1/conversations/:id" \
  -H "Authorization: Bearer $PROJECT_KEY"
POST/v1/conversations/{id}/attachmentshttps://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
id requiredpathstringThe conversation the token was minted for.
namequerystringThe 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

JSON
{
  "id": "string",
  "name": "string",
  "contentType": "string",
  "bytes": "integer"
}

Try it

curl -X POST "https://api.prodantix.com/v1/conversations/:id/attachments" \
  -H "Authorization: Bearer $PROJECT_KEY"
GET/v1/conversations/{id}/attachments/{attachmentId}https://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
id requiredpathstringThe conversation the token was minted for.
attachmentId requiredpathstringThe file, as a turn's attachments name it.

Responses

The file's bytes

Try it

curl -X GET "https://api.prodantix.com/v1/conversations/:id/attachments/:attachmentId" \
  -H "Authorization: Bearer $PROJECT_KEY"

guides

GET/v1/projects/{projectId}/guideshttps://api.prodantix.com

List guides

A project's tours, tooltips and checklists that are not archived, most recently changed first.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the guide belongs to.

Responses

The guides

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/guides" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/guideshttps://api.prodantix.com

Create a guide

Saves a draft tour, tooltip or checklist: its steps, appearance, targeting and schedule.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the guide belongs to.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "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"
}

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"}'
GET/v1/projects/{projectId}/guides/{guideId}https://api.prodantix.com

Read a guide

One guide with its steps, appearance, targeting and schedule.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the guide belongs to.
guideId requiredpathstringThe guide.

Responses

The guide

JSON
{
  "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"
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/projects/{projectId}/guides/{guideId}https://api.prodantix.com

Change a guide

Replaces a guide's name, steps, appearance, targeting and schedule.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the guide belongs to.
guideId requiredpathstringThe guide.

Body

JSON
{
  "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

JSON
{
  "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"
}

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"}'
POST/v1/projects/{projectId}/guides/{guideId}/starthttps://api.prodantix.com

Start a guide

Shows the guide to the visitors it targets from its start time.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the guide belongs to.
guideId requiredpathstringThe guide.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/start" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/guides/{guideId}/stophttps://api.prodantix.com

Stop a guide

Stops showing the guide; its results stay.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the guide belongs to.
guideId requiredpathstringThe guide.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/stop" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/guides/{guideId}/archivehttps://api.prodantix.com

Archive a guide

Removes the guide from the list; its results stay in the events.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the guide belongs to.
guideId requiredpathstringThe guide.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/archive" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/guides/{guideId}/duplicatehttps://api.prodantix.com

Duplicate a guide

Saves a draft copy of a guide.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the guide belongs to.
guideId requiredpathstringThe guide.
Idempotency-KeyheaderstringUp 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

JSON
{
  "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"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/duplicate" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/guides/{guideId}/resultshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the guide belongs to.
guideId requiredpathstringThe guide.
iterationqueryintegerThe round to read.

Responses

The results

JSON
{
  "shown": "integer",
  "completed": "integer",
  "dismissed": "integer",
  "missed": "integer",
  "steps": [
    {
      "stepId": "string",
      "visitors": "integer"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/guides/:guideId/results" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/guides/reachhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the guide belongs to.

Responses

The counts, one per guide shown at least once

JSON
{
  "guides": [
    {
      "guideId": "string",
      "reached": "integer",
      "completed": "integer"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/guides/reach" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/guideshttps://api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
distinct_id requiredquerystringThe visitor's distinct id.

Responses

The guides the visitor qualifies for

JSON
{
  "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"
    }
  ]
}

Try it

curl -X GET "https://api.prodantix.com/v1/guides" \
  -H "Authorization: Bearer $PROJECT_KEY"

events

GET/v1/projects/{projectId}/transformationshttps://api.prodantix.com

List ingest transformations

The project's transformations in the order they run, with how many events each matched today and yesterday.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the transformations belong to

Responses

200 The transformations

JSON
{
  "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"
POST/v1/projects/{projectId}/transformationshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the transformations belong to
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string",
  "event": "string",
  "action": "unknown",
  "enabled?": "boolean | null"
}

Responses

The transformation

JSON
{
  "id": "string",
  "position": "integer",
  "name": "string",
  "event": "string",
  "action": "unknown",
  "enabled": "boolean",
  "matchedToday": "integer",
  "matchedYesterday": "integer",
  "updatedAt": "string"
}

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}'
PUT/v1/projects/{projectId}/transformations/{transformationId}https://api.prodantix.com

Update an ingest transformation

Replaces a transformation's name, match and action, and switches it on or off.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the transformations belong to
transformationId requiredpathstringThe transformation's id

Body

JSON
{
  "name": "string",
  "event": "string",
  "action": "unknown",
  "enabled?": "boolean | null"
}

Responses

The transformation

JSON
{
  "id": "string",
  "position": "integer",
  "name": "string",
  "event": "string",
  "action": "unknown",
  "enabled": "boolean",
  "matchedToday": "integer",
  "matchedYesterday": "integer",
  "updatedAt": "string"
}

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}'
DELETE/v1/projects/{projectId}/transformations/{transformationId}https://api.prodantix.com

Delete an ingest transformation

Removes a transformation; the ones after it move up.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the transformations belong to
transformationId requiredpathstringThe transformation's id

Responses

Deleted

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/transformations/:transformationId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/transformations/{transformationId}/movehttps://api.prodantix.com

Move an ingest transformation

Moves a transformation to a position in the order, 0 running first.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the transformations belong to
transformationId requiredpathstringThe transformation's id
Idempotency-KeyheaderstringUp 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

JSON
{
  "position": "integer"
}

Responses

The transformations in their new order

JSON
{
  "transformations": [
    {
      "id": "string",
      "position": "integer",
      "name": "string",
      "event": "string",
      "action": "unknown",
      "enabled": "boolean",
      "matchedToday": "integer",
      "matchedYesterday": "integer",
      "updatedAt": "string"
    }
  ]
}

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}'
POST/v1/projects/{projectId}/transformations/testhttps://api.prodantix.com

Test ingest transformations

Runs a sample event through the project's enabled transformations and answers what would be stored. Nothing is stored.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the transformations belong to
Idempotency-KeyheaderstringUp 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

JSON
{
  "eventName": "string",
  "distinctId?": "string | null",
  "properties?": "object"
}

Responses

200 The event after the transformations

JSON
{
  "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":{}}'
GET/v1/projects/{projectId}/event-streamshttps://api.prodantix.com

List event streams

The endpoints a project forwards its arriving events to. The destination URL is sealed and only its host is returned.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the stream belongs to

Responses

200 The streams

JSON
{
  "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"
POST/v1/projects/{projectId}/event-streamshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the stream belongs to
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string",
  "events?": [],
  "url?": "string | null",
  "enabled?": "boolean | null"
}

Responses

The stream

JSON
{
  "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 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}'
PUT/v1/projects/{projectId}/event-streams/{streamId}https://api.prodantix.com

Update an event stream

Renames a stream, changes the events it forwards or its destination, or switches it on or off.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the stream belongs to
streamId requiredpathstringThe stream's id

Body

JSON
{
  "name": "string",
  "events?": [],
  "url?": "string | null",
  "enabled?": "boolean | null"
}

Responses

The stream

JSON
{
  "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 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}'
DELETE/v1/projects/{projectId}/event-streams/{streamId}https://api.prodantix.com

Delete an event stream

Stops a stream; its parked batches are dropped.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project the stream belongs to
streamId requiredpathstringThe stream's id

Responses

Deleted

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/event-streams/:streamId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/eventshttps://eu.api.prodantix.com

Ingest a batch of events

Accepts a batch of analytics events. A 202 means accepted for processing, not persisted.

Auth projectKey

Parameters

NameInTypeDescription
Idempotency-KeyheaderstringUp 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

JSON
{
  "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

JSON
{
  "accepted": "integer"
}

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"}'
POST/v1/identifyhttps://eu.api.prodantix.com

Identify a user

Associates traits with a distinct id. A 202 means accepted for processing, not persisted.

Auth projectKey

Parameters

NameInTypeDescription
Idempotency-KeyheaderstringUp 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

JSON
{
  "distinct_id?": "string | null",
  "event_id?": "string | null",
  "properties?": "object | null",
  "timestamp?": "string | null"
}

Responses

Accepted for processing

JSON
{
  "accepted": "integer"
}

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"}'
POST/v1/grouphttps://eu.api.prodantix.com

Associate a user with a group

Associates a distinct id with a group and its traits. A 202 means accepted for processing, not persisted.

Auth projectKey

Parameters

NameInTypeDescription
Idempotency-KeyheaderstringUp 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

JSON
{
  "distinct_id?": "string | null",
  "event_id?": "string | null",
  "properties?": "object | null",
  "timestamp?": "string | null"
}

Responses

Accepted for processing

JSON
{
  "accepted": "integer"
}

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"}'
POST/segment/v1/{call}https://eu.api.prodantix.com

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.

Auth projectKey

Parameters

NameInTypeDescription
call requiredpathstringtrack, 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-KeyheaderstringUp 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

JSON
{
  "success": "boolean"
}

Try it

curl -X POST "https://eu.api.prodantix.com/segment/v1/:call" \
  -H "Authorization: Bearer $PROJECT_KEY"

email

GET/v1/company/email/domainshttps://api.prodantix.com

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.

Auth bearerAuth

Responses

200 The domains

JSON
{
  "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"
POST/v1/company/email/domainshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string"
}

Responses

The domain

JSON
{
  "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 POST "https://api.prodantix.com/v1/company/email/domains" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'
POST/v1/company/email/domains/{domainId}/checkhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
domainId requiredpathstringThe sending domain
Idempotency-KeyheaderstringUp 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

JSON
{
  "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 POST "https://api.prodantix.com/v1/company/email/domains/:domainId/check" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/company/email/domains/{domainId}/trackinghttps://api.prodantix.com

Set a domain's tracking

The tracking subdomain (one label, such as links) and whether opens and clicks are tracked. Needs prodantix.email.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
domainId requiredpathstringThe sending domain

Body

JSON
{
  "subdomain": "string",
  "openTracking": "boolean",
  "clickTracking": "boolean"
}

Responses

The domain

JSON
{
  "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 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}'
DELETE/v1/company/email/domains/{domainId}https://api.prodantix.com

Remove a sending domain

Removes the domain at the provider and releases it; mail stops leaving from it. Needs prodantix.email.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
domainId requiredpathstringThe sending domain

Responses

The domain

JSON
{
  "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 DELETE "https://api.prodantix.com/v1/company/email/domains/:domainId" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/company/email/domains/{domainId}/dedicated-iphttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
domainId requiredpathstringThe sending domain
Idempotency-KeyheaderstringUp 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

JSON
{
  "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 POST "https://api.prodantix.com/v1/company/email/domains/:domainId/dedicated-ip" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/company/email/settingshttps://api.prodantix.com

Read the company's email settings

The postal address every marketing message carries and the DMARC report address. Needs prodantix.email.read.

Auth bearerAuth

Responses

200 The settings

JSON
{
  "postalAddress": "string",
  "dmarcReports": "string"
}

Try it

curl -X GET "https://api.prodantix.com/v1/company/email/settings" \
  -H "Authorization: Bearer $BEARER_AUTH"
PUT/v1/company/email/settingshttps://api.prodantix.com

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.

Auth bearerAuth

Body

JSON
{
  "postalAddress": "string",
  "dmarcReports": "string"
}

Responses

The settings

JSON
{
  "postalAddress": "string",
  "dmarcReports": "string"
}

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"}'
GET/v1/projects/{projectId}/email/subscription-typeshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Responses

200 The types

JSON
{
  "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"
POST/v1/projects/{projectId}/email/subscription-typeshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "key": "string",
  "texts": "unknown",
  "channel?": "string | null",
  "purpose?": "string | null",
  "doubleOptIn?": "boolean | null"
}

Responses

The type

JSON
{
  "id": "string",
  "key": "string",
  "texts": "unknown",
  "channel": "string",
  "purpose": "string",
  "doubleOptIn": "boolean",
  "archived": "boolean",
  "updatedAt": "string"
}

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}'
PUT/v1/projects/{projectId}/email/subscription-types/{typeId}https://api.prodantix.com

Change a subscription type

Its texts and double opt-in; the key, channel and purpose stay what people agreed to. Needs prodantix.email.manage.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
typeId requiredpathstringThe subscription type

Body

JSON
{
  "texts": "unknown",
  "doubleOptIn": "boolean"
}

Responses

The type

JSON
{
  "id": "string",
  "key": "string",
  "texts": "unknown",
  "channel": "string",
  "purpose": "string",
  "doubleOptIn": "boolean",
  "archived": "boolean",
  "updatedAt": "string"
}

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}'
POST/v1/projects/{projectId}/email/subscription-types/{typeId}/archivehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
typeId requiredpathstringThe subscription type
Idempotency-KeyheaderstringUp 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

JSON
{
  "archived": "boolean"
}

Responses

The type

JSON
{
  "id": "string",
  "key": "string",
  "texts": "unknown",
  "channel": "string",
  "purpose": "string",
  "doubleOptIn": "boolean",
  "archived": "boolean",
  "updatedAt": "string"
}

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}'
GET/v1/projects/{projectId}/email/suppressionshttps://api.prodantix.com

List suppressed addresses

The project's suppressions, the newest first, with why (hard_bounce, soft_bounce, complaint, provider, invalid, manual). Needs prodantix.email.read.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
searchquerystringThe start of an address
limitquerystringAt most 200; 50 when left out
offsetquerystringHow many to skip

Responses

200 The suppressions

JSON
{
  "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"
POST/v1/projects/{projectId}/email/suppressionshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "address": "string"
}

Responses

The suppression

JSON
{
  "suppression?": {
    "id": "string",
    "address": "string",
    "distinctId?": "string | null",
    "reason": "string",
    "createdBy": "string",
    "createdAt": "string"
  }
}

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"}'
DELETE/v1/projects/{projectId}/email/suppressions/{suppressionId}https://api.prodantix.com

Lift a suppression

Needs prodantix.users.write; one a bounce or complaint set also needs prodantix.email.manage, and the removal is audited.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
suppressionId requiredpathstringThe suppression

Responses

The lifted suppression

JSON
{
  "id": "string",
  "address": "string",
  "distinctId?": "string | null",
  "reason": "string",
  "createdBy": "string",
  "createdAt": "string"
}

Try it

curl -X DELETE "https://api.prodantix.com/v1/projects/:projectId/email/suppressions/:suppressionId" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/email/healthhttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
from requiredquerystringThe first day, YYYY-MM-DD
to requiredquerystringThe last day, YYYY-MM-DD

Responses

The health

JSON
{
  "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": []
}

Try it

curl -X GET "https://api.prodantix.com/v1/projects/:projectId/email/health" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST/v1/projects/{projectId}/email/resumehttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "resumed": "boolean"
}

Try it

curl -X POST "https://api.prodantix.com/v1/projects/:projectId/email/resume" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET/v1/projects/{projectId}/people/{distinctId}/email-subscriptionshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
distinctId requiredpathstringThe person

Responses

200 The person's subscriptions

JSON
{
  "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"
PUT/v1/projects/{projectId}/people/{distinctId}/email-subscriptions/{typeId}https://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
typeId requiredpathstringThe subscription type
distinctId requiredpathstringThe person

Body

JSON
{
  "subscribed": "boolean",
  "legalBasis": "string"
}

Responses

The person's subscriptions

JSON
{
  "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/email-subscriptions/:typeId" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{"subscribed":true,"legalBasis":"string"}'
PUT/v1/projects/{projectId}/people/{distinctId}/marketing-contacthttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
distinctId requiredpathstringThe person

Body

JSON
{
  "isMarketingContact": "boolean"
}

Responses

200 The person's subscriptions

JSON
{
  "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}'

marketing-emails

GET/v1/projects/{projectId}/marketing-emailshttps://api.prodantix.com

List marketing emails

The project's marketing emails, the latest changed first. Needs prodantix.marketing_emails.read.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project

Responses

200 The emails

JSON
{
  "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"
POST/v1/projects/{projectId}/marketing-emailshttps://api.prodantix.com

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.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
Idempotency-KeyheaderstringUp 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

JSON
{
  "name": "string",
  "kind?": "string | null",
  "template?": "string | null",
  "language?": "string | null"
}

Responses

The draft

JSON
{
  "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 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"}'
GET/v1/projects/{projectId}/marketing-emails/{emailId}https://api.prodantix.com

Read a marketing email

The email with its versions, test, send time, cohorts and approval. Needs prodantix.marketing_emails.read.

Auth bearerAuth

Parameters

NameInTypeDescription
projectId requiredpathstringThe project
emailId requiredpathstringThe marketing email

Responses