Update campaign

curl -X PUT "https://api.flameup.ai/api/v1/campaigns/example_string" \
  -H "Content-Type: application/json" \
  -H "X-Workspace-ID: example_string" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "John Doe",
  "trigger_config": {
    "event_names": [
      "John Doe"
    ],
    "filters": [
      {
        "field": "example_string",
        "operator": "eq",
        "value": "null"
      }
    ],
    "properties": {},
    "debounce": 3.14,
    "delay_minutes": 3.14,
    "max_per_user": 42,
    "first_occurrence": true
  },
  "status": "draft"
}'

import requests
import json

url = "https://api.flameup.ai/api/v1/campaigns/example_string"
headers = {
  "Content-Type": "application/json",
  "X-Workspace-ID": "example_string",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "name": "John Doe",
  "trigger_config": {
    "event_names": [
      "John Doe"
    ],
    "filters": [
      {
        "field": "example_string",
        "operator": "eq",
        "value": "null"
      }
    ],
    "properties": {},
    "debounce": 3.14,
    "delay_minutes": 3.14,
    "max_per_user": 42,
    "first_occurrence": true
  },
  "status": "draft"
}

response = requests.put(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://api.flameup.ai/api/v1/campaigns/example_string", {
  method: "PUT",
  headers: {
  "Content-Type": "application/json",
  "X-Workspace-ID": "example_string",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "name": "John Doe",
  "trigger_config": {
    "event_names": [
      "John Doe"
    ],
    "filters": [
      {
        "field": "example_string",
        "operator": "eq",
        "value": "null"
      }
    ],
    "properties": {},
    "debounce": 3.14,
    "delay_minutes": 3.14,
    "max_per_user": 42,
    "first_occurrence": true
  },
  "status": "draft"
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "name": "John Doe",
  "trigger_config": {
    "event_names": [
      "John Doe"
    ],
    "filters": [
      {
        "field": "example_string",
        "operator": "eq",
        "value": "null"
      }
    ],
    "properties": {},
    "debounce": 3.14,
    "delay_minutes": 3.14,
    "max_per_user": 42,
    "first_occurrence": true
  },
  "status": "draft"
}`)

    req, err := http.NewRequest("PUT", "https://api.flameup.ai/api/v1/campaigns/example_string", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("X-Workspace-ID", "example_string")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.flameup.ai/api/v1/campaigns/example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Put.new(uri)
request['Content-Type'] = 'application/json'
request['X-Workspace-ID'] = 'example_string'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
  "name": "John Doe",
  "trigger_config": {
    "event_names": [
      "John Doe"
    ],
    "filters": [
      {
        "field": "example_string",
        "operator": "eq",
        "value": "null"
      }
    ],
    "properties": {},
    "debounce": 3.14,
    "delay_minutes": 3.14,
    "max_per_user": 42,
    "first_occurrence": true
  },
  "status": "draft"
}'

response = http.request(request)
puts response.body

{}

PUT

/campaigns/{campaignId}

PUT

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

Bearer Tokenstring

Required

A Firebase ID token from a signed-in dashboard session. Endpoints using this scheme are NOT callable with an API key and will reject one.

Campaign ID

The media type of the request body

Options: application/json

header

X-Workspace-IDstring

Required

The workspace to operate on, for dashboard routes that carry no workspace_id path segment. A workspace_id query parameter is accepted as an alternative; either way the value is checked against the signed-in user's workspace membership before it is trusted.

namestring

trigger_configstring

Shape depends on the campaign's trigger_type — see EventTriggerConfig, WebhookTriggerConfig and ScheduleTriggerConfig. Activation-time rules apply when the update sets status: active.

statusstring

The settable statuses. scheduled and failed are set by the system and rejected here.

Options: draft, active, paused, archived, completed

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. A Firebase ID token from a signed-in dashboard session. Endpoints using this scheme are NOT callable with an API key and will reject one.

Path Parameters

campaignIdstring

Required

Campaign ID

Headers

X-Workspace-IDstring

Required

Body

application/json

namestring

trigger_configstring

Shape depends on the campaign's trigger_type — see EventTriggerConfig, WebhookTriggerConfig and ScheduleTriggerConfig. Activation-time rules apply when the update sets status: active.

statusstring

The settable statuses. scheduled and failed are set by the system and rejected here.

Allowed values:draftactivepausedarchivedcompleted

Responses

Campaign updated

Was this page helpful?