Docs
  1. Schemas
Docs
  • Authentication
  • SMS
    • List SMS messages
    • Send SMS message
    • Send a draft SMS campaign
    • Get SMS dashboard data
    • Resend multiple failed SMS messages
    • Get SMS message
    • Resend a failed SMS message
    • Send a draft SMS message
  • SMS Campaigns
    • List SMS campaigns
    • Create SMS campaign
    • Get SMS campaign
    • Update SMS campaign
    • Delete or cancel SMS campaign
    • Get SMS campaign messages
    • Resend entire campaign to all recipients
    • Resend all failed messages in a campaign
    • Send SMS campaign
    • Get SMS campaign statistics
  • SMS Contacts
    • List contacts
    • Create contact
    • Get contact
    • Update contact
    • Delete contact
  • SMS Templates
    • List message templates
    • Create message template
    • Get message template
    • Update message template
    • Delete message template
  • Schemas
    • Schemas
      • auth.Invitation
      • auth.InvitationRegisterRequest
      • auth.InvitationRequest
      • auth.Organization
      • auth.OrganizationCreateRequest
      • auth.OrganizationUpdateRequest
      • auth.UploadcareImageRequest
      • billing.PlanInfo
      • billing.PlanSwitchPreview
      • payment.JSONMap
      • payment.ProductSalesStats
      • payment.StateTransition
      • payment.Transaction
      • payment.TransactionItem
      • response.Response
      • sms.CreateSenderIDRequest
      • sms.DailySegmentBreakdown
      • sms.MonthlyDataset
      • sms.MonthlySegmentBreakdown
      • sms.MonthlyStats
      • sms.OrganizationBalance
      • sms.RecentActivity
      • sms.SMSCampaign
      • sms.SMSCampaignDetails
      • sms.SMSCampaignMessage
      • sms.SMSContact
      • sms.SMSContactGroup
      • sms.SMSDashboardData
      • sms.SMSSenderID
      • sms.SMSTemplate
      • sms.SegmentAnalytics
      • sms.Stats
      • sms.UpdateSenderIDRequest
      • sms.UsageTracking
      • v1.APIKeyResponse
      • v1.AddContactsParams
      • v1.CampaignActionResponse
      • v1.CampaignListResponse
      • v1.CampaignMessagesResponse
      • v1.CampaignResendResponse
      • v1.CampaignResponse
      • v1.CampaignSenderID
      • v1.CampaignStatisticsResponse
      • v1.CampaignStats
      • v1.CampaignTemplate
      • v1.ContactFormRequest
      • v1.ContactFormResponse
      • v1.ContactGroupInfo
      • v1.ContactGroupListResponse
      • v1.ContactGroupResponse
      • v1.ContactListResponse
      • v1.ContactResponse
      • v1.CreateAPIKeyParams
      • v1.CreateCampaignParams
      • v1.CreateContactGroupParams
      • v1.CreateContactParams
      • v1.CreateCustomerParams
      • v1.CreateDonationCampaignParams
      • v1.CreateImageParams
      • v1.CreateInvoiceParams
      • v1.CreatePaymentLinkParams
      • v1.CreateProductParams
      • v1.CreateTemplateParams
      • v1.CustomerListResponse
      • v1.CustomerResponse
      • v1.DonationCampaignListResponse
      • v1.DonationCampaignResponse
      • v1.ImageListResponse
      • v1.ImageResponse
      • v1.InitializePaymentParams
      • v1.InitializePaymentResponse
      • v1.InitiateTopUpRequest
      • v1.InvoiceItem
      • v1.InvoiceListResponse
      • v1.InvoiceResponse
      • v1.LoginRequest
      • v1.LoginResponse
      • v1.LoginWithInvitationRequest
      • v1.LoginWithInvitationResponse
      • v1.MessageResponse
      • v1.OrganizationInfo
      • v1.OrganizationPaymentSettingsResponse
      • v1.PasswordResetConfirmRequest
      • v1.PasswordResetRequest
      • v1.PaymentDashboardData
      • v1.PaymentLinkListResponse
      • v1.PaymentLinkProductDetail
      • v1.PaymentLinkResponse
      • v1.PaymentMethodResponse
      • v1.PaymentModeResponse
      • v1.PaymentStatusResponse
      • v1.PlanSubscriptionResponse
      • v1.PreviewPlanSwitchRequest
      • v1.ProductLineItem
      • v1.ProductListResponse
      • v1.ProductResponse
      • v1.RefundParams
      • v1.RefundResponse
      • v1.RegisterRequest
      • v1.ResendCampaignRequest
      • v1.ResendFailedSMSBatchRequest
      • v1.ResendFailedSMSBatchResponse
      • v1.ResendResult
      • v1.ResendVerificationRequest
      • v1.SMSListResponse
      • v1.SMSMessage
      • v1.SMSPlanResponse
      • v1.SMSResponse
      • v1.SendDraftCampaignParams
      • v1.SendDraftSMSParams
      • v1.SendInvoiceParams
      • v1.SendSMSAPIParams
      • v1.SenderIDListResponse
      • v1.SenderIDResponse
      • v1.SetPaymentModeRequest
      • v1.SubscribeToPlanRequest
      • v1.SuccessResponse
      • v1.TemplateListResponse
      • v1.TemplateResponse
      • v1.TransactionResponse
      • v1.UpdateCampaignParams
      • v1.UpdateContactGroupParams
      • v1.UpdateContactParams
      • v1.UpdateCustomerParams
      • v1.UpdateDonationCampaignParams
      • v1.UpdateInvoiceParams
      • v1.UpdatePaymentLinkParams
      • v1.UpdatePaymentSettingsRequest
      • v1.UpdateProductParams
      • v1.UpdateProfileParams
      • v1.UpdateSubscriptionRequest
      • v1.UpdateTemplateParams
      • v1.UserResponse
      • v1.VerifyEmailRequest
      • webhook.CreateEndpointParams
      • webhook.EndpointMetrics
      • webhook.Event
      • webhook.EventData
      • webhook.EventMetrics
      • webhook.EventRequest
      • webhook.EventType
      • webhook.UpdateEndpointParams
      • webhook.WebhookEndpoint
  1. Schemas

v1.CreateCampaignParams

{
    "contact_group_ids": [
        "string"
    ],
    "contact_ids": [
        "string"
    ],
    "is_draft": true,
    "message_body": "string",
    "message_template_id": "string",
    "name": "string",
    "scheduled_at": "string",
    "sender_id_config_id": "string",
    "template_params": {
        "property1": "string",
        "property2": "string"
    }
}
Built with