Outbound

Validate an Outbound definition

No writes, uploads, audience materialization, or sends. Checks the full definition, workspace references, field types, operators, schedules, survey branches, and plan access. Returns normalized defaults and warnings. For an existing campaign include messageId to check its edit restrictions. Errors contain repairable public field paths. Activation rechecks current conditions.

POST

/v2/outbound/validate

curl --request POST \
  --url https://do.featurebase.app/v2/outbound/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-09-03.pulsar' \
  --header 'Content-Type: application/json' \
  --data '
{
  "definition": {
    "assignee": {
      "id": "<string>",
      "type": "admin"
    },
    "audience": {
      "all": [
        {}
      ],
      "mode": "dynamic",
      "types": [
        "users"
      ]
    },
    "content": {
      "text": "<string>"
    },
    "name": "<string>",
    "options": {
      "action": "none",
      "allowReplies": true,
      "showAs": "badge"
    },
    "schedule": {
      "cooldown": {
        "interval": 123,
        "unit": "days"
      },
      "endsAt": "2026-10-01T09:00:00Z",
      "frequency": "once",
      "maxSends": 123,
      "recurrence": {
        "type": "weekly",
        "weekDays": [
          123
        ]
      },
      "startsAt": "2026-10-01T09:00:00Z",
      "timeRestriction": "any_time",
      "timeWindows": [
        {
          "dayOfWeek": 123,
          "end": "<string>",
          "start": "<string>"
        }
      ]
    },
    "sender": {
      "id": "<string>",
      "type": "admin"
    },
    "trigger": {
      "all": [
        {}
      ]
    },
    "type": "chat"
  },
  "messageId": "<string>"
}
'

{
  "activation": {
    "separateOperationRequired": true,
    "suggestedTargetState": "live"
  },
  "definition": {
    "assignee": {
      "id": "<string>",
      "type": "admin"
    },
    "audience": {
      "all": [
        {}
      ],
      "mode": "dynamic",
      "types": [
        "users"
      ]
    },
    "content": {
      "text": "<string>"
    },
    "name": "<string>",
    "options": {
      "action": "none",
      "allowReplies": true,
      "showAs": "badge"
    },
    "schedule": {
      "cooldown": {
        "interval": 123,
        "unit": "days"
      },
      "endsAt": "2026-10-01T09:00:00Z",
      "frequency": "once",
      "maxSends": 123,
      "recurrence": {
        "type": "weekly",
        "weekDays": [
          123
        ]
      },
      "startsAt": "2026-10-01T09:00:00Z",
      "timeRestriction": "any_time",
      "timeWindows": [
        {
          "dayOfWeek": 123,
          "end": "<string>",
          "start": "<string>"
        }
      ]
    },
    "sender": {
      "id": "<string>",
      "type": "admin"
    },
    "trigger": {
      "all": [
        {}
      ]
    },
    "type": "chat"
  },
  "object": "outbound_validation",
  "valid": true,
  "warnings": [
    "<string>"
  ]
}

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-09-03.pulsar, 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-09-03.pulsar

Body

definitionobjectrequired

Complete public campaign definition. Create saves a draft only. GET returns this same editable definition separately from read-only metadata.

Show child attributes

messageIdstring

Response

Success

activationobjectrequired

Show child attributes

definitionobjectrequired

Complete public campaign definition. Create saves a draft only. GET returns this same editable definition separately from read-only metadata.

Show child attributes

objectenum<string>required

Available options: outbound_validation

validenum<boolean>required

Available options: true

warningsstring[]required

Still need help? Ask the team