Recent searches

in
Developer ReferenceAPI

Site Inboxes

On this page

Get Site Inbox details

GET/api/v0/site-inboxes/{site_inbox_uuid}
Path parameters:
site_inbox_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/site-inboxes/{site_inbox_uuid} \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "default_inbox": true,
  "site_id": 0,
  "inbox_uuid": "string",
  "visible": true,
  "require_captcha": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "site_uuid": "00000000-0000-0000-0000-000000000000",
  "inbox": {
    "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_secret": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "organisation_uuid": "00000000-0000-0000-0000-000000000000",
    "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 site inbox details

PUT/api/v0/site-inboxes/{site_inbox_uuid}
Path parameters:
site_inbox_uuidUUIDRequired#
Request body:
inbox_uuidstring#
default_inboxboolean#
visibleboolean#
require_captchaboolean#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/site-inboxes/{site_inbox_uuid} \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "inbox_uuid": "string",
    "default_inbox": true,
    "visible": true,
    "require_captcha": true
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "default_inbox": true,
  "site_id": 0,
  "inbox_uuid": "string",
  "visible": true,
  "require_captcha": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "site_uuid": "00000000-0000-0000-0000-000000000000",
  "inbox": {
    "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_secret": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "organisation_uuid": "00000000-0000-0000-0000-000000000000",
    "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 Site Inbox

DELETE/api/v0/site-inboxes/{site_inbox_uuid}
Path parameters:
site_inbox_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/site-inboxes/{site_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
Open in a new tab