> ## Documentation Index > Fetch the complete documentation index at: https://docs.wave.sa/llms.txt > Use this file to discover all available pages before exploring further. # Create a campaign > Creates a campaign: Wave calls each recipient, paces the calls under your concurrency cap and call limits, retries the ones that did not answer, and runs machine detection first on each answered call. A person hears the stored callflow `callflow_name`; a machine gets the optional `voicemail_message` after the beep. Recipients: 1 to 10000 KSA numbers (5 with a sandbox key), each with an optional `reference` (at most 64 characters, never spoken). Duplicates are removed; the response gives the accepted and removed counts. `caller_id` must be a number your account owns (a sandbox key always presents the shared sandbox number). `max_concurrent` defaults to half your concurrency cap and must be below it. Without `start_at` (or with a past one) the campaign starts at once. `calling_window` is a daily window in KSA time. The body may be up to 2 MB. Requires the `campaigns:write` scope, and stored callflows to be enabled (409 CAMPAIGN_NEEDS_IVR). Needs campaigns to be enabled on the environment (503 until then); not available in production yet. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/campaigns openapi: 3.1.0 info: title: Wave API version: 1.0.0 description: >- Wave API Platform — voice, numbers, and messaging for Saudi Arabia. Request schemas are GENERATED from the @wave-sa/shared Zod schemas — do not edit by hand (run `pnpm --filter @wave-sa/api generate:openapi`). servers: - url: https://api.wave.sa security: - bearerAuth: [] paths: /v1/campaigns: post: tags: - Campaigns summary: Create a campaign description: >- Creates a campaign: Wave calls each recipient, paces the calls under your concurrency cap and call limits, retries the ones that did not answer, and runs machine detection first on each answered call. A person hears the stored callflow `callflow_name`; a machine gets the optional `voicemail_message` after the beep. Recipients: 1 to 10000 KSA numbers (5 with a sandbox key), each with an optional `reference` (at most 64 characters, never spoken). Duplicates are removed; the response gives the accepted and removed counts. `caller_id` must be a number your account owns (a sandbox key always presents the shared sandbox number). `max_concurrent` defaults to half your concurrency cap and must be below it. Without `start_at` (or with a past one) the campaign starts at once. `calling_window` is a daily window in KSA time. The body may be up to 2 MB. Requires the `campaigns:write` scope, and stored callflows to be enabled (409 CAMPAIGN_NEEDS_IVR). Needs campaigns to be enabled on the environment (503 until then); not available in production yet. operationId: createCampaign requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 100 callflow_name: type: string minLength: 1 maxLength: 100 caller_id: type: string maxLength: 20 recipients: type: array items: type: object properties: phone: type: string pattern: ^(\+966|0)(1[1-9]\d{7}|5\d{8}|800\d{7}|9200\d{6})$ reference: type: string maxLength: 64 required: - phone additionalProperties: false minItems: 1 maxItems: 10000 start_at: type: string format: date-time calling_window: type: object properties: start: type: string pattern: ^([01]\d|2[0-3]):[0-5]\d$ end: type: string pattern: ^([01]\d|2[0-3]):[0-5]\d$ required: - start - end additionalProperties: false max_attempts: type: integer minimum: 1 maximum: 5 default: 3 retry_after_minutes: type: integer minimum: 10 maximum: 1440 default: 30 max_concurrent: type: integer minimum: 1 voicemail_message: anyOf: - type: object properties: type: type: string enum: - play url: type: string minLength: 1 maxLength: 2048 required: - type - url additionalProperties: false - type: object properties: type: type: string enum: - say text: type: string minLength: 1 maxLength: 500 language: type: string enum: - ar - en required: - type - text additionalProperties: false required: - name - callflow_name - recipients additionalProperties: false responses: '201': description: The campaign; no call is placed yet content: application/json: schema: $ref: '#/components/schemas/CampaignCreated' '400': description: >- Validation error: a bad phone row (the message names it), too many recipients, an unknown callflow, a missing caller ID, `max_concurrent` at or above your cap, or a bad play URL content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- The key lacks the campaigns:write scope, or the caller ID is not yours (CLI_NOT_OWNED) content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: >- Stored callflows are not enabled on this environment (CAMPAIGN_NEEDS_IVR) content: application/json: schema: $ref: '#/components/schemas/Error' '413': description: The body is over 2 MB content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: Campaigns are not enabled for this environment content: application/json: schema: $ref: '#/components/schemas/Error' security: - bearerAuth: [] components: schemas: CampaignCreated: type: object properties: id: type: string format: uuid name: type: string status: type: string enum: - scheduled - running - paused - stopped - completed callflow_name: type: string caller_id: type: string start_at: type: string format: date-time calling_window: type: object nullable: true properties: start: type: string end: type: string max_attempts: type: integer retry_after_minutes: type: integer max_concurrent: type: integer voicemail_message: type: object nullable: true properties: type: type: string enum: - play - say url: type: string text: type: string language: type: string nullable: true sandbox: type: boolean created_at: type: string format: date-time started_at: type: string format: date-time nullable: true completed_at: type: string format: date-time nullable: true recipients_accepted: type: integer duplicates_removed: type: integer Error: type: object description: Wave's standard bilingual error envelope. required: - error_code - message - message_ar - request_id - docs_url properties: error_code: type: string enum: - INVALID_API_KEY - EXPIRED_API_KEY - REVOKED_API_KEY - SANDBOX_KEY_NOT_ALLOWED - INSUFFICIENT_PERMISSIONS - API_KEY_REVEAL_UNAVAILABLE - RATE_LIMIT_EXCEEDED - RECAPTCHA_FAILED - SANDBOX_EXPIRED - OTP_INVALID - OTP_EXPIRED - OTP_TOO_MANY_ATTEMPTS - OTP_RESEND_TOO_SOON - OTP_SEND_FAILED - INVALID_PHONE_NUMBER - CALLBACK_NOT_FOUND - CALLBACK_ALREADY_CANCELLED - CALLBACK_NOT_CANCELLABLE - CALL_NOT_FOUND - CALL_FAILED - INSUFFICIENT_CREDITS - CALL_NOT_CONTROLLABLE - CALL_NOT_ACTIVE - CALL_NOT_ANSWERED - AGENT_LEG_NOT_CONNECTED - CALL_CONTROL_FAILED - CALL_CONTROL_UNSUPPORTED - CALL_CONTROL_DISABLED - INVALID_PLAY_URL - TRANSFER_IN_PROGRESS - TRANSFER_TARGET_INVALID - TRANSFER_LIMIT_REACHED - CALL_VELOCITY_EXCEEDED - CONFERENCE_FULL - CALL_ALREADY_IN_CONFERENCE - CONFERENCE_NOT_FOUND - CONFERENCE_ENDED - CAMPAIGNS_DISABLED - CAMPAIGN_NOT_FOUND - CAMPAIGN_INVALID_STATE - CAMPAIGN_NEEDS_IVR - QUEUE_CONTROL_FAILED - QUEUE_SERVICE_UNAVAILABLE - RECORDING_NOT_FOUND - RECORDING_URL_EXPIRED - RECORDING_SERVICE_UNAVAILABLE - CALLFLOW_AUDIO_SERVICE_UNAVAILABLE - CALLFLOW_VERSION_CONFLICT - VOICE_AUTH_DISABLED - VOICE_AUTH_NOT_FOUND - VOICE_AUTH_ASSURANCE_UNSUPPORTED - VOICE_AUTH_RATE_LIMITED - VOICE_AUTH_BLOCKED - VOICE_AUTH_BRAND_NOT_APPROVED - VOICE_AUTH_BRAND_NOT_FOUND - VOICE_AUTH_BRAND_INVALID_STATE - VOICE_AUTH_BRAND_DUPLICATE - VERIFY_DISABLED - VERIFY_NOT_FOUND - VERIFY_INVALID_CODE - VERIFY_MAX_ATTEMPTS - VERIFY_EXPIRED - VERIFY_RATE_LIMITED - VERIFY_SEND_FAILED - VERIFY_BLOCKED - VOICEMAIL_DISABLED - VOICEMAIL_NOT_FOUND - VOICEMAIL_RECORDING_NOT_FOUND - VOICEMAIL_SERVICE_UNAVAILABLE - VOICEMAIL_GREETING_INVALID - DLQ_REPLAY_DISABLED - DLQ_REPLAY_BROKER_UNAVAILABLE - MESSAGES_DISABLED - IVR_DISABLED - SANDBOX_INVALID_QUEUE - SANDBOX_QUEUE_UNAVAILABLE - SANDBOX_SIMULATED_SERVER_ERROR - SANDBOX_DESTINATION_NOT_ALLOWED - SANDBOX_MINUTES_EXCEEDED - WIDGET_ORIGIN_NOT_ALLOWED - PROJECT_NOT_FOUND - WEBHOOK_URL_INVALID - WEBHOOK_UNREACHABLE - WEBHOOK_LIMIT_EXCEEDED - WEBHOOK_URL_DUPLICATE - WEBHOOK_NOT_FOUND - WEBHOOK_VERIFICATION_FAILED - SIGNUP_EMAIL_TAKEN - SIGNUP_VALIDATION_FAILED - VITALPBX_PROVISIONING_FAILED - SIGNUP_FAILED - API_KEY_NOT_FOUND - API_KEY_REVEAL_FORBIDDEN - PRODUCTION_ACCESS_ALREADY_REQUESTED - PRODUCTION_TIER_REQUIRED - PRODUCTION_REQUEST_EXISTS - PRODUCTION_REQUEST_NOT_FOUND - PRODUCTION_REQUEST_INVALID_STATE - VALIDATION_ERROR - INTERNAL_ERROR - NOT_FOUND - PAYLOAD_TOO_LARGE - IDEMPOTENCY_KEY_CONFLICT - INVALID_CREDENTIALS - SESSION_REQUIRED - INVALID_ACCESS_TOKEN - EXPIRED_ACCESS_TOKEN - INVALID_REFRESH_TOKEN - EXPIRED_REFRESH_TOKEN - REFRESH_REUSE_DETECTED - REFRESH_ROTATION_RACE - SESSION_IDLE_TIMEOUT - WEB_CALLING_DISABLED - ORIGIN_NOT_ALLOWED - WEBRTC_CONCURRENCY_LIMIT - WCS_NOT_FOUND - WCS_EXPIRED - WCS_REVOKED - WCS_REUSE_DETECTED - WCS_NOT_ALLOWED_AS_BEARER - WEBRTC_PROVISIONING_FAILED - TURN_UNAVAILABLE - INVALID_IDENTITY - IDENTITY_CONFLICT - PROFILE_VALIDATION_FAILED - PASSWORD_VALIDATION_FAILED - INVALID_CURRENT_PASSWORD - PASSWORD_SSO_ONLY - SETUP_ALREADY_COMPLETE - INVALID_NATIONAL_ID - NAFATH_INITIATE_FAILED - NAFATH_NOT_VERIFIED - NAFATH_REJECTED - NAFATH_EXPIRED - NAFATH_ALREADY_REGISTERED - NAFATH_INVALID_WEBHOOK - NAFATH_ALREADY_VERIFIED - NAFATH_REQUIRED - ADMIN_UNAUTHORIZED - ADMIN_INVALID_CREDENTIALS - ADMIN_ORG_OWNER_EMAIL_TAKEN - ADMIN_USER_NOT_FOUND - INSUFFICIENT_ROLE - LAST_OWNER - INVALID_SCOPE - NUMBER_NOT_AVAILABLE - NUMBER_NOT_FOUND - NUMBER_ALREADY_ASSIGNED - NUMBER_PROVIDER_ERROR - PORTING_INVALID_STATE - PORTING_NOT_FOUND - OWN_DID_NUMBER_REQUIRED - OWN_DID_NUMBER_NOT_AUTHORIZED - OWN_DID_NUMBER_UNAVAILABLE - SPEND_CAP_EXCEEDED - RATE_PLAN_NOT_FOUND - PAYMENT_FAILED - DUPLICATE_USAGE_EVENT - INVOICE_NOT_FOUND - PAYMENT_NOT_FOUND - PAYMENT_AMOUNT_MISMATCH - INSUFFICIENT_PROJECT_BALANCE - INSUFFICIENT_POOL_BALANCE - PROJECT_NOT_FOUND_FOR_ALLOCATION - ENGINE_UNAUTHORIZED - CALLFLOW_TENANT_NOT_FOUND - CLI_NOT_OWNED - WEBHOOK_UNAUTHORIZED - CHANNEL_NOT_CONFIGURED - WEBHOOK_PAYLOAD_INVALID - RECIPIENT_OPTED_OUT - QUIET_HOURS_ACTIVE - CONSENT_LOCKED_BY_END_USER - INVITE_NOT_FOUND - INVITE_NOT_PENDING - INVITE_EXPIRED - INVITE_ROLE_INVALID - INVITE_ALREADY_MEMBER - INVITE_EMAIL_OTHER_ORG - INVITE_ACCOUNT_DETAILS_REQUIRED message: type: string description: English message. message_ar: type: string description: Arabic message. request_id: type: string docs_url: type: string format: uri securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: sk_sandbox_* | sk_live_* description: >- Your API key from the Wave dashboard. Sandbox keys start `sk_sandbox_`; production keys start `sk_live_`. Send as `Authorization: Bearer `. Some endpoints require a production key and specific scopes. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.