Ricky logorickyDocs

Definir el archivo del encabezado de una automatización programada

POST
/workflows/{workflow_id}/header-media

Descarga el archivo de url y lo guarda como el encabezado que lleva cada envío de una automatización programada, en lugar del anterior. La plantilla de la automatización debe tener un encabezado de imagen, video o documento, y el archivo debe ser de ese tipo. Responde la automatización, con has_header_image en true.

Permiso: workflows:write.

Autorización

bearerAuth
headerAuthorizationBearer <clave>

Una clave de API de la organización, rky_live_…, creada en Configuración → API. Envíala solo desde un servidor.

Parámetros de ruta

workflow_id*string

ID del workflow.

Formatouuid

Parámetros de cabecera

Idempotency-Key?string

Opcional. Un valor que eliges, único por escritura lógica, de 8 a 200 caracteres: un UUID o un ID de tu sistema, como order-10482-ready. Reintentar con la misma clave y el mismo cuerpo repite la primera respuesta en lugar de repetir la escritura.

Longitud8 <= length <= 200

Cuerpo de la solicitud

application/json
  1. body

El archivo que lleva cada envío de la automatización en el encabezado de su plantilla.

url*string

Dirección HTTPS pública de la que Ricky descarga el archivo. No debe redirigir ni apuntar a una dirección privada, y su Content-Type debe ser del tipo que admite el encabezado de la plantilla (imagen, video o documento), dentro del límite de tamaño de WhatsApp para ese tipo.

Formatouri
Longitudlength <= 2048
file_name?string

Nombre que se guarda para el archivo; por defecto, la última parte de la URL.

Longitud1 <= length <= 240

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*

Una automatización que Ricky ejecuta para la organización.

curl -X POST 'https://getricky.ai/api/v1/workflows/497f6eca-6276-4993-bfeb-53cbbbba6f08/header-media' \  -H 'Idempotency-Key: order-10482-ready' \  -H 'Content-Type: application/json' \  -d '{  "url": "https://example.com/recordatorio.jpg"}'
{  "data": {    "id": "a3b4c5d6-e7f8-4a9b-8c0d-2e3f4a5b6c7d",    "name": "Fuera de horario",    "status": "active",    "type": "conversation",    "definition": {      "trigger": "conversation_opened",      "channel_ids": [        "8f3c2a5e-6b1d-4c7a-9e2f-1a2b3c4d5e6f"      ],      "condition": {        "kind": "outside_business_hours",        "business_hours": {          "start": "09:00",          "end": "18:00",          "timezone": "America/Panama",          "weekdays": [            1,            2,            3,            4,            5          ]        }      },      "flow": {        "entry": "bienvenida",        "steps": [          {            "id": "bienvenida",            "kind": "send_message",            "text": "Hola, gracias por escribir a Casa Nativa. Abrimos de lunes a viernes de 9:00 a 18:00.",            "next": "motivo"          },          {            "id": "motivo",            "kind": "ask_question",            "text": "¿En qué te ayudamos?",            "answer_key": "motivo",            "choices": [              {                "id": "pedido",                "label": "Mi pedido",                "next": "asesor"              },              {                "id": "otro",                "label": "Otra consulta",                "next": "agente"              }            ],            "timeout_seconds": 3600,            "on_timeout": "agente",            "on_invalid": "agente",            "next": "agente"          },          {            "id": "asesor",            "kind": "assign_user",            "user_id": "2d4f6a8c-1b3d-4e5f-8a7b-9c0d1e2f3a4b",            "next": null          },          {            "id": "agente",            "kind": "assign_agent",            "agent_id": "7e8f9a0b-1c2d-4e3f-a4b5-c6d7e8f9a0b1",            "next": null          }        ]      }    },    "updated_at": "2026-10-14T15:30:00.000Z"  }}