Saltar al contenido principal
POST
/
campaigns
/
{id}
/
{action}
cURL
curl --request POST \
  --url https://api.altur.io/api/v1.0/campaigns/{id}/{action} \
  --header 'Authorization: <api-key>'
{
  "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": {}
  }
}
Límite de Tasa: 12 solicitudes por segundo
action es uno de activate, pause, archive, resume.

​
Transiciones Válidas

AcciónEstados de origen permitidosEfecto
activatepending, ready, cooldownestablece status → active
pauseactive, cooldownestablece status → inactive
resumeinactiveestablece status → active
archivecualquieraestablece archived = true

​
Idempotencia

  • archive siempre es exitoso. Re-archivar una campaña es un no-op.
  • pause en una campaña ya inactive, y resume en una campaña ya active, son no-ops exitosos.
  • activate no es idempotente: llamarlo en una campaña ya en active (o inactive, o finished) devuelve 409 INVALID_STATUS_TRANSITION porque active no está en los orígenes permitidos. Usa resume para reactivar una campaña pausada.

​
Errores

  • 400 UNKNOWN_ACTION: action no es uno de los valores soportados.
  • 402 BILLING_LIMIT_REACHED: activate o resume y se alcanzó el límite del plan.
  • 409 INVALID_STATUS_TRANSITION: el estado actual no está en los orígenes permitidos. La respuesta incluye current_status y valid_targets.

​
Ejemplos

curl -X POST "https://api.altur.io/api/v1.0/campaigns/1234/activate" \
  -H "Authorization: api-key YOUR_API_SECRET_KEY"

Autorizaciones

​
Authorization
string
header
requerido

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

Parámetros de ruta

​
id
integer
requerido

The identifier of the Campaign

​
action
enum<string>
requerido

Lifecycle action to apply

Opciones disponibles:
activate,
pause,
archive,
resume

Respuesta

Lifecycle action applied 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.