Skip to main content
POST
/
api
/
campaigns
/
validate-date
Validate that a date has enough remaining SMS quota
curl --request POST \
  --url https://your-instance.example.com/api/campaigns/validate-date \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scheduledISO": "2026-05-20T15:00:00.000Z",
  "contactCount": 250
}
'
{
  "success": true,
  "available": true,
  "remaining": 250,
  "limit": 500
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
scheduledISO
string<date-time>
required

UTC ISO timestamp the campaign is scheduled for. The org-local date is derived from this.

​
contactCount
integer
required

Number of contacts the campaign will message on the resolved date.

Required range: x >= 0
​
excludeCampaignId
string

When editing an existing campaign, excludes its current reservation on this date from the quota check.

Response

Validation result returned

​
success
boolean
required
​
available
boolean
required

True when remaining quota >= contactCount (or when the org has unlimited quota).

​
remaining
integer | null

Remaining SMS slots on the resolved date; null for unlimited plans.

​
limit
integer | null

Daily SMS cap for the org; null for unlimited plans.

​
message
string

Human-readable explanation populated only when available=false.