Update a campaign

Update a draft campaign’s name, group, audience (mailing list, segment, or filter), or scheduling.

POST /v1/campaigns/{campaignId}

Update a campaign

cURL

curl --request POST \
  --url https://app.loops.so/api/v1/campaigns/{campaignId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "campaignGroupId": "<string>",
  "mailingListId": "<string>",
  "audienceSegmentId": "<string>",
  "audienceFilter": {
    "conditions": [
      {
        "type": "property",
        "key": "<string>",
        "value": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://app.loops.so/api/v1/campaigns/{campaignId}"

payload = {
    "name": "<string>",
    "campaignGroupId": "<string>",
    "mailingListId": "<string>",
    "audienceSegmentId": "<string>",
    "audienceFilter": { "conditions": [
            {
                "type": "property",
                "key": "<string>",
                "value": "<string>"
            }
        ] }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    campaignGroupId: '<string>',
    mailingListId: '<string>',
    audienceSegmentId: '<string>',
    audienceFilter: {conditions: [{type: 'property', key: '<string>', value: '<string>'}]}
  })
};

fetch('https://app.loops.so/api/v1/campaigns/{campaignId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.loops.so/api/v1/campaigns/{campaignId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'campaignGroupId' => '<string>',
    'mailingListId' => '<string>',
    'audienceSegmentId' => '<string>',
    'audienceFilter' => [
        'conditions' => [
                [
                                'type' => 'property',
                                'key' => '<string>',
                                'value' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.loops.so/api/v1/campaigns/{campaignId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"campaignGroupId\": \"<string>\",\n  \"mailingListId\": \"<string>\",\n  \"audienceSegmentId\": \"<string>\",\n  \"audienceFilter\": {\n    \"conditions\": [\n      {\n        \"type\": \"property\",\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.loops.so/api/v1/campaigns/{campaignId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"campaignGroupId\": \"<string>\",\n  \"mailingListId\": \"<string>\",\n  \"audienceSegmentId\": \"<string>\",\n  \"audienceFilter\": {\n    \"conditions\": [\n      {\n        \"type\": \"property\",\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.loops.so/api/v1/campaigns/{campaignId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"campaignGroupId\": \"<string>\",\n  \"mailingListId\": \"<string>\",\n  \"audienceSegmentId\": \"<string>\",\n  \"audienceFilter\": {\n    \"conditions\": [\n      {\n        \"type\": \"property\",\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  }\n}"

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

200

{
  "id": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "emailMessageId": "<string>",
  "campaignGroupId": "<string>",
  "mailingListId": "<string>",
  "audienceSegmentId": "<string>",
  "audienceFilter": {
    "conditions": [
      {
        "type": "property",
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "scheduling": {
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Campaigns can only be updated while they are in Draft status. At least one field must be provided.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId · string · required

The ID of the campaign.

Body

application/json

At least one field must be provided.

name · string

The updated campaign name.

campaignGroupId · string

The ID of the group to move this campaign to.

mailingListId · string | null

The ID of the mailing list to send to.

audienceSegmentId · string | null

The ID of an audience segment. Setting this clears any audienceFilter.

audienceFilter · object | null

An inline audience filter to apply to this campaign. If audienceSegmentId is also provided, this filter will be applied in addition to the segment's filter.

Show child attributes

scheduling · object

When the campaign should send. timestamp is required and must be in the future when method is schedule, and must be omitted when method is now.

Show child attributes

Response

200

application/json

Campaign updated.

id · string · required

The ID of the campaign.

name · string · required

The name of the campaign.

status · enum<string> · required

The status of the campaign.

Available options: Draft, Scheduled, Sending, Sent

createdAt · string<date-time> · required

ISO 8601 timestamp for when the campaign was created.

updatedAt · string<date-time> · required

ISO 8601 timestamp for when the campaign was last updated.

emailMessageId · string | null · required

The associated email message ID.

campaignGroupId · string | null · required

The ID of the campaign group this campaign belongs to..

mailingListId · string | null · required

The ID of the mailing list this campaign sends to, if set.

audienceSegmentId · string | null · required

The ID of the audience segment this campaign targets, if set.

audienceFilter · object | null · required

The filter rules that define the audience for this campaign, if set.

Show child attributes

scheduling · object · required

When the campaign is scheduled to send.

Show child attributes