Update Campaign

Actualización parcial de una Campaña. Los campos inmutables (agent_id, integration_id, integration_type, cycles.enabled, cycles.mode) no se pueden modificar y devuelven IMMUTABLE_FIELD. Las campañas finalizadas son de solo lectura.

PATCH /campaigns/{id}

cURL

cURL

curl --request PATCH \
  --url https://api.altur.io/api/v1.0/campaigns/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "timezone": "<string>",
  "retries": 2,
  "message_limit": 5000,
  "scheduling": {
    "mon": {
      "startTime": "<string>",
      "stopTime": "<string>",
      "active": true
    },
    "tue": {
      "startTime": "<string>",
      "stopTime": "<string>",
      "active": true
    },
    "wed": {
      "startTime": "<string>",
      "stopTime": "<string>",
      "active": true
    },
    "thu": {
      "startTime": "<string>",
      "stopTime": "<string>",
      "active": true
    },
    "fri": {
      "startTime": "<string>",
      "stopTime": "<string>",
      "active": true
    },
    "sat": {
      "startTime": "<string>",
      "stopTime": "<string>",
      "active": true
    },
    "sun": {
      "startTime": "<string>",
      "stopTime": "<string>",
      "active": true
    }
  },
  "first_message": "<string>",
  "template": "<string>",
  "template_alt": "<string>",
  "cycles": {
    "enabled": true,
    "max_iterations": 7,
    "cooldown_minutes": 720,
    "filter_statuses": [
      "<string>"
    ],
    "filter_tags": [
      "<string>"
    ],
    "schedule": {
      "mon": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      },
      "tue": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      },
      "wed": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      },
      "thu": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      },
      "fri": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      },
      "sat": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      },
      "sun": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      }
    },
    "schedule_start_date": "2023-12-25",
    "schedule_end_date": "2023-12-25"
  }
}
'

import requests

url = "https://api.altur.io/api/v1.0/campaigns/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "timezone": "<string>",
    "retries": 2,
    "message_limit": 5000,
    "scheduling": {
        "mon": {
            "startTime": "<string>",
            "stopTime": "<string>",
            "active": True
        },
        "tue": {
            "startTime": "<string>",
            "stopTime": "<string>",
            "active": True
        },
        "wed": {
            "startTime": "<string>",
            "stopTime": "<string>",
            "active": True
        },
        "thu": {
            "startTime": "<string>",
            "stopTime": "<string>",
            "active": True
        },
        "fri": {
            "startTime": "<string>",
            "stopTime": "<string>",
            "active": True
        },
        "sat": {
            "startTime": "<string>",
            "stopTime": "<string>",
            "active": True
        },
        "sun": {
            "startTime": "<string>",
            "stopTime": "<string>",
            "active": True
        }
    },
    "first_message": "<string>",
    "template": "<string>",
    "template_alt": "<string>",
    "cycles": {
        "enabled": True,
        "max_iterations": 7,
        "cooldown_minutes": 720,
        "filter_statuses": ["<string>"],
        "filter_tags": ["<string>"],
        "schedule": {
            "mon": {
                "startTime": "<string>",
                "stopTime": "<string>",
                "active": True
            },
            "tue": {
                "startTime": "<string>",
                "stopTime": "<string>",
                "active": True
            },
            "wed": {
                "startTime": "<string>",
                "stopTime": "<string>",
                "active": True
            },
            "thu": {
                "startTime": "<string>",
                "stopTime": "<string>",
                "active": True
            },
            "fri": {
                "startTime": "<string>",
                "stopTime": "<string>",
                "active": True
            },
            "sat": {
                "startTime": "<string>",
                "stopTime": "<string>",
                "active": True
            },
            "sun": {
                "startTime": "<string>",
                "stopTime": "<string>",
                "active": True
            }
        },
        "schedule_start_date": "2023-12-25",
        "schedule_end_date": "2023-12-25"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    timezone: '<string>',
    retries: 2,
    message_limit: 5000,
    scheduling: {
      mon: {startTime: '<string>', stopTime: '<string>', active: true},
      tue: {startTime: '<string>', stopTime: '<string>', active: true},
      wed: {startTime: '<string>', stopTime: '<string>', active: true},
      thu: {startTime: '<string>', stopTime: '<string>', active: true},
      fri: {startTime: '<string>', stopTime: '<string>', active: true},
      sat: {startTime: '<string>', stopTime: '<string>', active: true},
      sun: {startTime: '<string>', stopTime: '<string>', active: true}
    },
    first_message: '<string>',
    template: '<string>',
    template_alt: '<string>',
    cycles: {
      enabled: true,
      max_iterations: 7,
      cooldown_minutes: 720,
      filter_statuses: ['<string>'],
      filter_tags: ['<string>'],
      schedule: {
        mon: {startTime: '<string>', stopTime: '<string>', active: true},
        tue: {startTime: '<string>', stopTime: '<string>', active: true},
        wed: {startTime: '<string>', stopTime: '<string>', active: true},
        thu: {startTime: '<string>', stopTime: '<string>', active: true},
        fri: {startTime: '<string>', stopTime: '<string>', active: true},
        sat: {startTime: '<string>', stopTime: '<string>', active: true},
        sun: {startTime: '<string>', stopTime: '<string>', active: true}
      },
      schedule_start_date: '2023-12-25',
      schedule_end_date: '2023-12-25'
    }
  })
};

fetch('https://api.altur.io/api/v1.0/campaigns/{id}', 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://api.altur.io/api/v1.0/campaigns/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'timezone' => '<string>',
    'retries' => 2,
    'message_limit' => 5000,
    'scheduling' => [
        'mon' => [
                'startTime' => '<string>',
                'stopTime' => '<string>',
                'active' => true
        ],
        'tue' => [
                'startTime' => '<string>',
                'stopTime' => '<string>',
                'active' => true
        ],
        'wed' => [
                'startTime' => '<string>',
                'stopTime' => '<string>',
                'active' => true
        ],
        'thu' => [
                'startTime' => '<string>',
                'stopTime' => '<string>',
                'active' => true
        ],
        'fri' => [
                'startTime' => '<string>',
                'stopTime' => '<string>',
                'active' => true
        ],
        'sat' => [
                'startTime' => '<string>',
                'stopTime' => '<string>',
                'active' => true
        ],
        'sun' => [
                'startTime' => '<string>',
                'stopTime' => '<string>',
                'active' => true
        ]
    ],
    'first_message' => '<string>',
    'template' => '<string>',
    'template_alt' => '<string>',
    'cycles' => [
        'enabled' => true,
        'max_iterations' => 7,
        'cooldown_minutes' => 720,
        'filter_statuses' => [
                '<string>'
        ],
        'filter_tags' => [
                '<string>'
        ],
        'schedule' => [
                'mon' => [
                                'startTime' => '<string>',
                                'stopTime' => '<string>',
                                'active' => true
                ],
                'tue' => [
                                'startTime' => '<string>',
                                'stopTime' => '<string>',
                                'active' => true
                ],
                'wed' => [
                                'startTime' => '<string>',
                                'stopTime' => '<string>',
                                'active' => true
                ],
                'thu' => [
                                'startTime' => '<string>',
                                'stopTime' => '<string>',
                                'active' => true
                ],
                'fri' => [
                                'startTime' => '<string>',
                                'stopTime' => '<string>',
                                'active' => true
                ],
                'sat' => [
                                'startTime' => '<string>',
                                'stopTime' => '<string>',
                                'active' => true
                ],
                'sun' => [
                                'startTime' => '<string>',
                                'stopTime' => '<string>',
                                'active' => true
                ]
        ],
        'schedule_start_date' => '2023-12-25',
        'schedule_end_date' => '2023-12-25'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://api.altur.io/api/v1.0/campaigns/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"retries\": 2,\n  \"message_limit\": 5000,\n  \"scheduling\": {\n    \"mon\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"tue\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"wed\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"thu\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"fri\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"sat\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"sun\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    }\n  },\n  \"first_message\": \"<string>\",\n  \"template\": \"<string>\",\n  \"template_alt\": \"<string>\",\n  \"cycles\": {\n    \"enabled\": true,\n    \"max_iterations\": 7,\n    \"cooldown_minutes\": 720,\n    \"filter_statuses\": [\n      \"<string>\"\n    ],\n    \"filter_tags\": [\n      \"<string>\"\n    ],\n    \"schedule\": {\n      \"mon\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"tue\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"wed\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"thu\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"fri\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"sat\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"sun\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      }\n    },\n    \"schedule_start_date\": \"2023-12-25\",\n    \"schedule_end_date\": \"2023-12-25\"\n  }\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.patch("https://api.altur.io/api/v1.0/campaigns/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"retries\": 2,\n  \"message_limit\": 5000,\n  \"scheduling\": {\n    \"mon\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"tue\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"wed\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"thu\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"fri\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"sat\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"sun\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    }\n  },\n  \"first_message\": \"<string>\",\n  \"template\": \"<string>\",\n  \"template_alt\": \"<string>\",\n  \"cycles\": {\n    \"enabled\": true,\n    \"max_iterations\": 7,\n    \"cooldown_minutes\": 720,\n    \"filter_statuses\": [\n      \"<string>\"\n    ],\n    \"filter_tags\": [\n      \"<string>\"\n    ],\n    \"schedule\": {\n      \"mon\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"tue\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"wed\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"thu\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"fri\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"sat\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"sun\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      }\n    },\n    \"schedule_start_date\": \"2023-12-25\",\n    \"schedule_end_date\": \"2023-12-25\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.altur.io/api/v1.0/campaigns/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"retries\": 2,\n  \"message_limit\": 5000,\n  \"scheduling\": {\n    \"mon\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"tue\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"wed\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"thu\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"fri\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"sat\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    },\n    \"sun\": {\n      \"startTime\": \"<string>\",\n      \"stopTime\": \"<string>\",\n      \"active\": true\n    }\n  },\n  \"first_message\": \"<string>\",\n  \"template\": \"<string>\",\n  \"template_alt\": \"<string>\",\n  \"cycles\": {\n    \"enabled\": true,\n    \"max_iterations\": 7,\n    \"cooldown_minutes\": 720,\n    \"filter_statuses\": [\n      \"<string>\"\n    ],\n    \"filter_tags\": [\n      \"<string>\"\n    ],\n    \"schedule\": {\n      \"mon\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"tue\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"wed\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"thu\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"fri\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"sat\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      },\n      \"sun\": {\n        \"startTime\": \"<string>\",\n        \"stopTime\": \"<string>\",\n        \"active\": true\n      }\n    },\n    \"schedule_start_date\": \"2023-12-25\",\n    \"schedule_end_date\": \"2023-12-25\"\n  }\n}"

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

200

{
  "success": true,
  "campaign": {
    "id": 123,
    "name": "<string>",
    "integration": {
      "id": "<string>"
    },
    "agent": {
      "id": "<string>",
      "name": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "scheduling": {
      "mon": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      },
      "tue": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      },
      "wed": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      },
      "thu": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      },
      "fri": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      },
      "sat": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      },
      "sun": {
        "startTime": "<string>",
        "stopTime": "<string>",
        "active": true
      }
    },
    "cycles": {
      "enabled": true,
      "max_iterations": 7,
      "cooldown_minutes": 720,
      "filter_statuses": [
        "<string>"
      ],
      "filter_tags": [
        "<string>"
      ],
      "schedule": {
        "mon": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        },
        "tue": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        },
        "wed": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        },
        "thu": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        },
        "fri": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        },
        "sat": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        },
        "sun": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        }
      },
      "schedule_start_date": "2023-12-25",
      "schedule_end_date": "2023-12-25"
    },
    "analytics": {}
  }
}

{
  "success": false,
  "message": "<string>",
  "field": "<string>"
}

{
  "error": 123,
  "message": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "field": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "field": "<string>"
}

Rate Limit: 12 requests per second

Immutable Fields

The following fields cannot be modified after creation. Including them in a PATCH returns 400 IMMUTABLE_FIELD and identifies the offending field in the response field key:

• agent_id
• integration_id
• integration_type
• cycles.enabled
• cycles.mode

Finished campaigns are read-only and return 409 CAMPAIGN_FINISHED on any PATCH.

Cycle Updates

Cycle fields can only be updated on campaigns that have cycles enabled (400 CYCLES_NOT_ENABLED otherwise). schedule, schedule_start_date, and schedule_end_date are only valid when cycles.mode is scheduled (400 SCHEDULED_MODE_ONLY otherwise).

Examples

Rename a campaign and tighten retries

cURL

curl -X PATCH "https://api.altur.io/api/v1.0/campaigns/1234" \
  -H "Authorization: api-key YOUR_API_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q2 Reactivation - wave 2",
    "retries": 2
  }'

import requests

response = requests.patch(
    "https://api.altur.io/api/v1.0/campaigns/1234",
    headers={"Authorization": "api-key YOUR_API_SECRET_KEY"},
    json={"name": "Q2 Reactivation - wave 2", "retries": 2},
)
response.raise_for_status()

await fetch("https://api.altur.io/api/v1.0/campaigns/1234", {
  method: "PATCH",
  headers: {
    Authorization: "api-key YOUR_API_SECRET_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ name: "Q2 Reactivation - wave 2", retries: 2 }),
});

Update cycle cooldown

cURL

curl -X PATCH "https://api.altur.io/api/v1.0/campaigns/1234" \
  -H "Authorization: api-key YOUR_API_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "cycles": { "cooldown_minutes": 60 }
  }'

requests.patch(
    "https://api.altur.io/api/v1.0/campaigns/1234",
    headers={"Authorization": "api-key YOUR_API_SECRET_KEY"},
    json={"cycles": {"cooldown_minutes": 60}},
).raise_for_status()

await fetch("https://api.altur.io/api/v1.0/campaigns/1234", {
  method: "PATCH",
  headers: {
    Authorization: "api-key YOUR_API_SECRET_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ cycles: { cooldown_minutes: 60 } }),
});

Authorizations

Authorization · string · header · required

Add api-key YOUR_API_SECRET_KEY as the value of the Authorization header.

Path Parameters

id · integer · required

The identifier of the Campaign

Body

application/json

Partial Campaign update

Partial update. Any field may be omitted. Immutable fields (agent_id, integration_id, integration_type, cycles.enabled, cycles.mode) cannot be included.

name · string

Maximum string length: 255

description · string

timezone · string

retries · integer

Required range: 0 <= x <= 5

message_limit · integer

Required range: 1 <= x <= 10000

scheduling · object

Show child attributes

first_message · string

template · string

template_alt · string

cycles · object

Cycles configuration block. Phone-call campaigns only.

Show child attributes

Response

200

application/json

Campaign updated successfully

success · boolean

campaign · object

Single Campaign detail with nested agent, integration and cycles config. The analytics field is included only when a snapshot is available for the campaign.

Show child attributes