Create Campaign

Crea una nueva Campaña para tu organización. Usa integration_type para seleccionar entre llamada telefónica o WhatsApp; los campos exclusivos del canal contrario son rechazados.

POST /campaigns

cURL

cURL

curl --request POST \
  --url https://api.altur.io/api/v1.0/campaigns \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "agent_id": "<string>",
  "integration_id": "<string>",
  "description": "<string>",
  "timezone": "<string>",
  "retries": 1,
  "message_limit": 250,
  "first_message": "<string>",
  "template": "<string>",
  "template_alt": "<string>",
  "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"
  }
}
'

import requests

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

payload = {
    "name": "<string>",
    "agent_id": "<string>",
    "integration_id": "<string>",
    "description": "<string>",
    "timezone": "<string>",
    "retries": 1,
    "message_limit": 250,
    "first_message": "<string>",
    "template": "<string>",
    "template_alt": "<string>",
    "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"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    agent_id: '<string>',
    integration_id: '<string>',
    description: '<string>',
    timezone: '<string>',
    retries: 1,
    message_limit: 250,
    first_message: '<string>',
    template: '<string>',
    template_alt: '<string>',
    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'
    }
  })
};

fetch('https://api.altur.io/api/v1.0/campaigns', 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",
  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>',
    'agent_id' => '<string>',
    'integration_id' => '<string>',
    'description' => '<string>',
    'timezone' => '<string>',
    'retries' => 1,
    'message_limit' => 250,
    'first_message' => '<string>',
    'template' => '<string>',
    'template_alt' => '<string>',
    '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'
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"integration_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"retries\": 1,\n  \"message_limit\": 250,\n  \"first_message\": \"<string>\",\n  \"template\": \"<string>\",\n  \"template_alt\": \"<string>\",\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  \"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("POST", 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.post("https://api.altur.io/api/v1.0/campaigns")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"integration_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"retries\": 1,\n  \"message_limit\": 250,\n  \"first_message\": \"<string>\",\n  \"template\": \"<string>\",\n  \"template_alt\": \"<string>\",\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  \"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")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"integration_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"retries\": 1,\n  \"message_limit\": 250,\n  \"first_message\": \"<string>\",\n  \"template\": \"<string>\",\n  \"template_alt\": \"<string>\",\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  \"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

201

{
  "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

Pass an Idempotency-Key header (UUID recommended) so retries don’t create duplicate campaigns.

Channel-specific Fields

Field	Channel
first_message	phone_call
template	whatsapp
template_alt	whatsapp

Sending a channel-only field for the wrong integration_type returns a 400 INVALID_REQUEST.

Cycles

cycles is optional. When cycles.enabled is false (or omitted), the rest of the cycles block is ignored. When cycles.mode is cooldown, schedule* fields are rejected. Cycles can be enabled only at creation time; cycles.enabled and cycles.mode are immutable thereafter.

Examples

Phone-call campaign with cooldown cycles

cURL

curl -X POST "https://api.altur.io/api/v1.0/campaigns" \
  -H "Authorization: api-key YOUR_API_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f0b2c8c-2a7e-4f5e-9b6a-3a2e8b9c4d10" \
  -d '{
    "name": "Q2 Reactivation",
    "agent_id": "6cy951e6-9877-4d7c-88d7-56b4948d3cce",
    "integration_id": "iph_8YqL3mZxR1tV0nKfH9bA",
    "integration_type": "phone_call",
    "timezone": "America/Mexico_City",
    "first_message": "Hi, am I speaking with {name}?",
    "cycles": {
      "enabled": true,
      "mode": "cooldown",
      "max_iterations": 3,
      "cooldown_minutes": 30,
      "filter_statuses": ["converted"]
    }
  }'

import requests
import uuid

payload = {
    "name": "Q2 Reactivation",
    "agent_id": "6cy951e6-9877-4d7c-88d7-56b4948d3cce",
    "integration_id": "iph_8YqL3mZxR1tV0nKfH9bA",
    "integration_type": "phone_call",
    "timezone": "America/Mexico_City",
    "first_message": "Hi, am I speaking with {name}?",
    "cycles": {
        "enabled": True,
        "mode": "cooldown",
        "max_iterations": 3,
        "cooldown_minutes": 30,
        "filter_statuses": ["converted"],
    },
}

response = requests.post(
    "https://api.altur.io/api/v1.0/campaigns",
    headers={
        "Authorization": "api-key YOUR_API_SECRET_KEY",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json=payload,
)
response.raise_for_status()
campaign = response.json()["campaign"]
print(campaign["id"])

const payload = {
  name: "Q2 Reactivation",
  agent_id: "6cy951e6-9877-4d7c-88d7-56b4948d3cce",
  integration_id: "iph_8YqL3mZxR1tV0nKfH9bA",
  integration_type: "phone_call",
  timezone: "America/Mexico_City",
  first_message: "Hi, am I speaking with {name}?",
  cycles: {
    enabled: true,
    mode: "cooldown",
    max_iterations: 3,
    cooldown_minutes: 30,
    filter_statuses: ["converted"],
  },
};

const res = await fetch("https://api.altur.io/api/v1.0/campaigns", {
  method: "POST",
  headers: {
    Authorization: "api-key YOUR_API_SECRET_KEY",
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify(payload),
});
const { campaign } = await res.json();

WhatsApp campaign

cURL

curl -X POST "https://api.altur.io/api/v1.0/campaigns" \
  -H "Authorization: api-key YOUR_API_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Promo June",
    "agent_id": "6cy951e6-9877-4d7c-88d7-56b4948d3cce",
    "integration_id": "iwa_8YqL3mZxR1tV0nKfH9bA",
    "integration_type": "whatsapp",
    "template": "promo_june_v1"
  }'

import requests

response = requests.post(
    "https://api.altur.io/api/v1.0/campaigns",
    headers={"Authorization": "api-key YOUR_API_SECRET_KEY"},
    json={
        "name": "Promo June",
        "agent_id": "6cy951e6-9877-4d7c-88d7-56b4948d3cce",
        "integration_id": "iwa_8YqL3mZxR1tV0nKfH9bA",
        "integration_type": "whatsapp",
        "template": "promo_june_v1",
    },
)
response.raise_for_status()

await fetch("https://api.altur.io/api/v1.0/campaigns", {
  method: "POST",
  headers: {
    Authorization: "api-key YOUR_API_SECRET_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Promo June",
    agent_id: "6cy951e6-9877-4d7c-88d7-56b4948d3cce",
    integration_id: "iwa_8YqL3mZxR1tV0nKfH9bA",
    integration_type: "whatsapp",
    template: "promo_june_v1",
  }),
});

Authorizations

Authorization · string · header · required

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

Headers

Idempotency-Key · string

Optional client-generated key (UUID recommended) to make the request idempotent. Replays within the dedup window return the original response.

Body

application/json

Campaign to be created

name · string · required

Maximum string length: 255

agent_id · string<uuid4> · required

public_id of the agent that will own this campaign.

integration_id · string · required

public_id of the integration to use. Must belong to agent_id.

integration_type · enum<string> · required

Available options: phone_call, whatsapp

description · string

timezone · string

IANA timezone. Defaults to America/Mexico_City.

retries · integer · default: 1

Required range: 0 <= x <= 5

message_limit · integer · default: 250

Required range: 1 <= x <= 10000

first_message · string

First message the Agent will say upon the call being answered. Phone-call only.

template · string

WhatsApp template name. WhatsApp only.

template_alt · string

Alternate WhatsApp template name. WhatsApp only.

scheduling · object

Show child attributes

cycles · object

Cycles configuration block. Phone-call campaigns only.

Show child attributes

Response

201

application/json

Campaign created 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