Skip to content

Open-source live-chat, email support, omni-channel desk. An alternative to Intercom, Zendesk, Salesforce Service Cloud etc. 🔥💬

1.4 KB
Raw Blame
type: object
required: [campaign]
properties:
  campaign:
    description: >-
      Choose the variant matching the inbox referenced by inbox_id. The channel type
      is stored on the inbox and cannot be inferred from this request by a schema validator.
      These variants describe the inputs needed for delivery; creation can accept incomplete
      inputs without guaranteeing that the campaign will send.
    allOf:
      - $ref: '#/components/schemas/campaign_fields'
      - type: object
        required: [title, inbox_id, message]
      - anyOf:
          - title: Website campaign
            description: For a Website inbox, supply URL trigger rules. An audience is not required.
            type: object
            required: [trigger_rules]
            properties:
              trigger_rules:
                type: object
                required: [url]
                properties:
                  url:
                    type: string
                    format: uri
          - title: SMS campaign
            description: For an SMS or Twilio SMS inbox, supply at least one audience label.
            type: object
            required: [audience]
          - title: WhatsApp campaign
            description: For a WhatsApp Cloud inbox with campaigns enabled, supply audience labels and template parameters.
            type: object
            required: [audience, template_params]