Recent searches

in
Developer ReferenceAPI

Inboxes

On this page

Get an Inbox's details#

GET/api/v0/inboxes/{inbox_uuid}
Path parameters:
inbox_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inboxes/{inbox_uuid} \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "name": "string",
  "key": "string",
  "monthly_quota": 0,
  "keep_form_hook_days": 0,
  "organisation_id": 0,
  "captcha_type": "string",
  "captcha_key": "string",
  "captcha_config": {
    "project_id": "string",
    "min_score": 0,
    "send_sitekey": true
  },
  "allow_uploads": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "organisation_uuid": "00000000-0000-0000-0000-000000000000",
  "has_captcha_secret": true,
  "inbox_targets": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "target_type": "string",
      "target": "string",
      "validated": true,
      "config": {},
      "inbox_uuid": "00000000-0000-0000-0000-000000000000",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Update an Inbox's details#

PUT/api/v0/inboxes/{inbox_uuid}
Path parameters:
inbox_uuidUUIDRequired#
Request body:
namestring#

A name for the Inbox.

keystring#

The Inbox's unique key.

keep_form_hook_daysintegerNullable#

The number of days to retain submissions.

captcha_keystringNullable#

The captcha provider's site key.

captcha_secretstringNullable#

The captcha provider's secret key, or the Google Cloud API key for google_enterprise.

captcha_typestringNullable#

The captcha provider: google (reCAPTCHA), google_enterprise (reCAPTCHA Enterprise), hcaptcha, or turnstile.

captcha_configobject#

Options for the captcha provider: project_id is the Google Cloud project that holds the reCAPTCHA key, required for google_enterprise; min_score (0 to 1, default 0.5) rejects lower-scoring tokens for google and google_enterprise; send_sitekey (default true) tells hcaptcha which site key to expect. Keys you send are merged into the stored options, a key sent as null is removed, null for the whole object clears it, and keys for other providers are dropped.

project_idstringNullable#
min_scorenumber (float)Nullable#
send_sitekeybooleanNullable#
allow_uploadsboolean#

Whether forms on this inbox accept file uploads.

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inboxes/{inbox_uuid} \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "key": "string",
    "keep_form_hook_days": 0,
    "captcha_key": "string",
    "captcha_secret": "string",
    "captcha_type": "string",
    "captcha_config": {
      "project_id": "string",
      "min_score": 0,
      "send_sitekey": true
    },
    "allow_uploads": true
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "name": "string",
  "key": "string",
  "monthly_quota": 0,
  "keep_form_hook_days": 0,
  "organisation_id": 0,
  "captcha_type": "string",
  "captcha_key": "string",
  "captcha_config": {
    "project_id": "string",
    "min_score": 0,
    "send_sitekey": true
  },
  "allow_uploads": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "organisation_uuid": "00000000-0000-0000-0000-000000000000",
  "has_captcha_secret": true,
  "inbox_targets": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "target_type": "string",
      "target": "string",
      "validated": true,
      "config": {},
      "inbox_uuid": "00000000-0000-0000-0000-000000000000",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Delete an Inbox#

DELETE/api/v0/inboxes/{inbox_uuid}
Path parameters:
inbox_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inboxes/{inbox_uuid} \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
204Deleted
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Start an Inbox's submissions CSV export#

GET/api/v0/inboxes/{inbox_uuid}/export
Path parameters:
inbox_uuidUUIDRequired#
Query parameters:
categorystring#

Filter submissions by category

Allowed values: spam sent forwarded errored pending

uuidsarray#

Only export the submissions with these UUIDs

automatically_marked_spamboolean#
cleared_at_gtstring#
cleared_at_gtestring#
cleared_at_ltstring#
cleared_at_ltestring#
created_at_gtstring#
created_at_gtestring#
created_at_ltstring#
created_at_ltestring#
explicitly_marked_statusinteger#
has_errorstring | integer | boolean | string (date-time)#
has_spam_check_errorstring | integer | boolean | string (date-time)#
hoststring#
idinteger#
inbox_uuidstring#
ipstring#
last_sent_at_gtstring#
last_sent_at_gtestring#
last_sent_at_ltstring#
last_sent_at_ltestring#
org_idinteger#
org_uuidstring#
recaptchaboolean#
sentboolean#
sent_count_gtinteger#
sent_count_gteinteger#
sent_count_ltinteger#
sent_count_lteinteger#
site_idinteger#
site_uuidstring#
spam_checkedboolean#
updated_at_gtstring#
updated_at_gtestring#
updated_at_ltstring#
updated_at_ltestring#
uuidstring#
searchstring#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inboxes/{inbox_uuid}/export \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "status": "string",
  "token": "string"
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Get the status of an Inbox's submissions CSV export#

GET/api/v0/inboxes/{inbox_uuid}/export/{token}
Path parameters:
inbox_uuidUUIDRequired#
tokenstringRequired#

The export token returned when the export was started

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inboxes/{inbox_uuid}/export/{token} \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "status": "string",
  "url": "string",
  "error": "string"
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

List an Inbox's Form Hooks#

GET/api/v0/inboxes/{inbox_uuid}/form-hooks
Path parameters:
inbox_uuidUUIDRequired#
Filters:
categorystring#

Filter Form Hooks by category

Allowed values: spam sent forwarded errored pending

automatically_marked_spamboolean#
cleared_at_gtstring#
cleared_at_gtestring#
cleared_at_ltstring#
cleared_at_ltestring#
created_at_gtstring#
created_at_gtestring#
created_at_ltstring#
created_at_ltestring#
explicitly_marked_statusinteger#
has_errorstring | integer | boolean | string (date-time)#
has_spam_check_errorstring | integer | boolean | string (date-time)#
hoststring#
idinteger#
inbox_uuidstring#
ipstring#
last_sent_at_gtstring#
last_sent_at_gtestring#
last_sent_at_ltstring#
last_sent_at_ltestring#
org_idinteger#
org_uuidstring#
recaptchaboolean#
sentboolean#
sent_count_gtinteger#
sent_count_gteinteger#
sent_count_ltinteger#
sent_count_lteinteger#
site_idinteger#
site_uuidstring#
spam_checkedboolean#
updated_at_gtstring#
updated_at_gtestring#
updated_at_ltstring#
updated_at_ltestring#
uuidstring#
searchstring#
Sorting:
sort_attributestring#

Attribute to sort the results by

Defaults to: "created_at"

Allowed values: last_sent_at created_at id uuid

sort_directionstring#

Direction to sort the results

Defaults to: "DESC"

Allowed values: ASC DESC

Pagination:
pageinteger#

Page number to fetch (1-indexed)

itemsinteger#

Number of items per page

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inboxes/{inbox_uuid}/form-hooks \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "sent": true,
    "recaptcha": true,
    "ip": "string",
    "host": "string",
    "data": {},
    "timings": {},
    "error": "string",
    "explicitly_marked_status": "no_mark",
    "automatically_marked_spam": true,
    "spam_checked": true,
    "last_sent_at": "2024-01-01T00:00:00Z",
    "cleared_at": "2024-01-01T00:00:00Z",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "inbox_uuid": "string",
    "site_uuid": "00000000-0000-0000-0000-000000000000"
  }
]
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

List an Inbox's Targets#

GET/api/v0/inboxes/{inbox_uuid}/targets
Path parameters:
inbox_uuidUUIDRequired#
Query parameters:
searchstring#
created_at_gtstring#
created_at_gtestring#
created_at_ltstring#
created_at_ltestring#
idinteger#
inbox_uuidstring#
target_typestring#
updated_at_gtstring#
updated_at_gtestring#
updated_at_ltstring#
updated_at_ltestring#
uuidstring#
validatedboolean#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inboxes/{inbox_uuid}/targets \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "target_type": "string",
    "target": "string",
    "validated": true,
    "config": {},
    "inbox_uuid": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
]
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Create an Inbox Target#

POST/api/v0/inboxes/{inbox_uuid}/targets
Path parameters:
inbox_uuidUUIDRequired#
Request body:
target_typestringRequired#

The integration type: email, webhook, zapier, make, ifttt, slack, discord, teams, hubspot, n8n, pipedream, integromat, automate.

targetstringRequired#

The destination: an email address, or the integration's webhook URL.

configobject#

Additional configuration options for the target.

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inboxes/{inbox_uuid}/targets \
  -X POST \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "target_type": "string",
    "target": "string",
    "config": {}
  }'
Terminal
Responses:
201Created
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "target_type": "string",
  "target": "string",
  "validated": true,
  "config": {},
  "inbox_uuid": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

View a file uploaded to an Inbox#

GET/api/v0/inboxes/{inbox_uuid}/upload/{key}
Path parameters:
inbox_uuidUUIDRequired#
keystringRequired#

The uploaded file's key

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/inboxes/{inbox_uuid}/upload/{key} \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
303Redirect
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response
Open in a new tab