overlay: 1.0.0
info:
title: API Evangelist enhancements for the Campaign Manager Scheduled Campaigns API
version: 1.0.0
extends: openapi/optus-scheduled-campaigns-api-openapi.yml
x-apievangelist:
generated: '2026-10-21'
method: generated
source: openapi/optus-scheduled-campaigns-api-openapi.yml + overlays carried forward from the 2026-07-25
overlays on openapi/_original/ (campaign-manager)
note: Additive only; never mutates the extended document. Actions whose targets no longer exist in the
split document were dropped, Swagger 2.0 $.definitions targets were rebased to $.components.schemas,
and operationId updates were removed because the split document already declares its own operationIds.
actions:
- target: $.info
update:
x-apievangelist-provider: optus
x-apievangelist-repo: https://github.com/api-evangelist/optus
x-live-copy: https://api.sms.optus.com.au/rest/campaign_manager/v1/swagger.json
x-apievangelist-note: A live copy of this document is served from the API host (HTTP 200), but that
copy declares host api.modicagroup.com. The Optus-branded docs copy is the one harvested here.
x-artifacts:
authentication: authentication/optus-authentication.yml
conventions: conventions/optus-conventions.yml
errors: errors/optus-error-codes.yml
data_model: data-model/optus-data-model.yml
- target: $.info
update:
x-conventions:
tenancy: every path is scoped by the {application_name} segment, which is also the Basic auth username
pagination: none - list and template collections return in full
idempotency: none
- target: $.paths['/{application_name}/scheduled_campaigns'].post
update:
summary: Schedule an SMS campaign
x-action-class: acting
x-consequence: physical
x-blast-radius: Highest-consequence operation on the entire Optus public surface. The spec permits
up to 1,000,000 members in a single request and the send is scheduled, not previewed. Agentic callers
should require explicit human confirmation.
x-human-in-the-loop: recommended
x-agentic-access: agentic-access/optus-agentic-access.yml
- target: $.components.schemas.Member
update:
x-apievangelist-note: param1..param6 are free-text merge fields (50 characters each) substituted into
templates at send time.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.