Skip to main content
API docs by Redocly

drow API definition (1.0.0)

drow API definition

/v1/campaign-attachments

/v1/campaign-attachments/

query Parameters
campaign-id
required
string <uuid>
Example: campaign-id=11111111-1111-1111-1111-111111111111
filter[filename]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/campaign-attachments/

Request Body schema: application/json
required
object
type
required
string
Value: "campaign-attachments"
required
object
campaign-id
required
string <uuid>
content-type
required
string
Enum: "application/msword" "application/pdf" "application/vnd.ms-excel" "application/vnd.ms-powerpoint" "application/vnd.openxmlformats-officedocument.presentationml.presentation" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" "application/vnd.openxmlformats-officedocument.wordprocessingml.document" "audio/mpeg" "audio/ogg" "audio/x-wav" "image/avif" "image/bmp" "image/gif" "image/heic" "image/jpeg" "image/png" "image/tiff" "image/webp" "video/3gpp" "video/mp4" "video/mpeg" "video/quicktime" "video/webm" "video/x-m4v" "video/x-msvideo"
filename
required
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "expiration-time": 0,
  • "id": "11111111-1111-1111-1111-111111111111",
  • "upload-data": { },
  • "upload-url": "string"
}

/v1/campaign-attachments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/campaign-attachments/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
with-link
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/campaign-attachments/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/campaign-beacons

/v1/campaign-beacons/{id}/

path Parameters
id
required
string

Resource identifier

Responses

/v1/campaign-contact-logs

/v1/campaign-contact-logs/

query Parameters
campaign-id
required
string <uuid>
Example: campaign-id=11111111-1111-1111-1111-111111111111
filter[contact-id]
string <uuid>
Example: filter[contact-id]=11111111-1111-1111-1111-111111111111
filter[email]
string <email>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/campaign-contact-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/campaign-contacts

/v1/campaign-contacts/

query Parameters
campaign-id
required
string <uuid>
Example: campaign-id=11111111-1111-1111-1111-111111111111
filter[email]
string <email>
filter[phone]
string <phonenumberE164>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/campaign-contacts/

Request Body schema: application/json
required
object
type
required
string
Value: "campaign-contacts"
required
object
campaign-id
required
string <uuid>
email
string <email>
phone
string <phonenumberE164>
send-email
boolean
Default: true
send-sms
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/campaign-contacts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/campaign-contacts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/campaign-contacts/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "campaign-contacts"
required
object
send-email
boolean
send-sms
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/campaign-contacts/{id}/text-response/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
message
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "message": "string"
}

Response samples

Content type
application/vnd.api+json
null

/v1/campaign-redirectors

/v1/campaign-redirectors/

query Parameters
id
required
string <uuid>
Example: id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/campaign-redirects

/v1/campaign-redirects/

query Parameters
campaign-id
required
string <uuid>
Example: campaign-id=11111111-1111-1111-1111-111111111111
filter[contact-id]
string <uuid>
Example: filter[contact-id]=11111111-1111-1111-1111-111111111111
filter[tag]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/campaign-redirects/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/campaign-redirects/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/campaign-redirects/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "campaign-redirects"
required
object
tag
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/campaigns

/v1/campaigns/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/campaigns/

Request Body schema: application/json
required
object
type
required
string
Value: "campaigns"
required
object
name
required
string <= 255 characters
organization-id
required
string <uuid>
auto-onboard
boolean
Default: false
data
object
display-name
string <= 255 characters
email-from
string <= 255 characters
Default: "support@carium.com"
email-subject
string <= 255 characters
email-template
string <= 999999 characters
sms-template
string <= 1024 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/campaigns/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/campaigns/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/campaigns/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "campaigns"
required
object
auto-onboard
boolean
data
object
display-name
string <= 255 characters
email-from
string <= 255 characters
email-subject
string <= 255 characters
email-template
string <= 999999 characters
name
string <= 255 characters
sms-template
string <= 1024 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/campaigns/{id}/add-contacts/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
emails
required
Array of strings non-empty [ items <= 255 characters ]

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ]
}

Response samples

Content type
application/vnd.api+json
null

/v1/campaigns/{id}/get-preview/

path Parameters
id
required
string

Resource identifier

query Parameters
contact-id
required
string <uuid>
Example: contact-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/campaigns/{id}/start/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
emails
Array of strings[ items <= 255 characters ]
resend
boolean
Default: false
object
sends-threshold
integer
views-threshold
integer

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "resend": false,
  • "resend-filter": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/contact-uploads

/v1/contact-uploads/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/contact-uploads/

Request Body schema: application/json
required
object
type
required
string
Value: "contact-uploads"
required
object or object
Any of
content-type
required
string <= 255 characters
filename
required
string <= 255 characters
organization-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/contact-uploads/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/contact-uploads/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "task-id": "11111111-1111-1111-1111-111111111111"
}

/v1/contacts

/v1/contacts/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[bounced]
boolean
filter[email]
string <= 255 characters
filter[registered]
boolean
filter[unsubscribed]
boolean
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/contacts/

Request Body schema: application/json
required
object
type
required
string
Value: "contacts"
required
object
first-name
required
string <= 255 characters
last-name
required
string <= 255 characters
organization-id
required
string <uuid>
birth-date
string <date>
data
object
email
string <email>
locale
string <= 32 characters
phone
string <phonenumberE164>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/contacts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/contacts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/contacts/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "contacts"
required
object
birth-date
string <date>
data
object
email
string <email>
first-name
string <= 255 characters
last-name
string <= 255 characters
phone
string <phonenumberE164>
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/contacts/{id}/unsubscribe/

path Parameters
id
required
string

Resource identifier

Responses

/v1/design-components

/v1/design-components/

query Parameters
design-id
required
string <uuid>
Example: design-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/design-components/

Request Body schema: application/json
required
object
type
required
string
Value: "design-components"
required
object
design-id
required
string <uuid>
name
required
string <= 255 characters
args
object
text
string <= 99999 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/design-components/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/design-components/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
with-link
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/design-files

/v1/design-files/

query Parameters
design-id
required
string <uuid>
Example: design-id=11111111-1111-1111-1111-111111111111
filter[filename]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/design-files/

Request Body schema: application/json
required
object
type
required
string
Value: "design-files"
required
object
content-type
required
string <= 255 characters
design-id
required
string <uuid>
filename
required
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "expiration-time": 0,
  • "id": "11111111-1111-1111-1111-111111111111",
  • "upload-data": { },
  • "upload-url": "string"
}

/v1/design-files/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/design-files/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
with-link
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/design-files/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/designs

/v1/designs/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/designs/

Request Body schema: application/json
required
object
type
required
string
Value: "designs"
required
object
name
required
string <= 255 characters
organization-id
required
string <uuid>
type
required
string <= 255 characters
description
string <= 9999 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/designs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/designs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/designs/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "designs"
required
object
description
string <= 9999 characters
name
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/designs/{id}/export-campaign/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
campaign-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "campaign-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/purge-data

/v1/purge-data/

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/purge-data/

Request Body schema: application/json
required
object
type
required
string
Value: "system-purges"
required
object
entity-id
required
string <= 255 characters
entity-type
required
string
Enum: "individual" "organization" "user"
reference-id
required
string <= 255 characters
request-id
required
string <= 255 characters
archive
boolean
Default: false
property name*
additional property
any
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/replicators

/v1/replicators/

query Parameters
filter[classpath]
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/replicators/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers

/v1/sniffers/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/sniffers/

Request Body schema: application/json
required
object
type
required
string
Value: "sniffers"
required
object
user-id
required
string <uuid>
valid-until
required
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/get-logs/

path Parameters
id
required
string

Resource identifier

query Parameters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}