Ricky logorickyDocs

Asignar los campos de una plantilla

PUT
/templates/{template_id}/field-mappings

Reemplaza todas las asignaciones de la plantilla. Cada una nombra una variable de variables y un campo del contacto; un campo personalizado debe ser de la organización.

Permiso: templates: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

template_id*string

ID de la plantilla.

Patrón^[0-9]{1,32}$

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

Los campos del contacto que llenan las variables de la plantilla cuando Ricky la envía.

mappings*array<>

Todas las asignaciones de la plantilla; las que no envíes se quitan. Envía [] para quitarlas todas.

Elementositems <= 100

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*

Los campos del contacto que llenan las variables de una plantilla cuando Ricky la envía a un contacto. Se aplican al nombre y al idioma de la plantilla en su cuenta de negocio.

curl -X PUT 'https://getricky.ai/api/v1/templates/string/field-mappings' \  -H 'Idempotency-Key: order-10482-ready' \  -H 'Content-Type: application/json' \  -d '{  "mappings": [    {      "component": "body",      "key": "1",      "source": {        "kind": "native",        "field": "first_name"      }    },    {      "component": "body",      "key": "2",      "source": {        "kind": "custom",        "field_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"      }    }  ]}'
{  "data": {    "template_id": "1234567890123456",    "variables": [      {        "component": "body",        "key": "1",        "name": "{{1}}"      }    ],    "mappings": [      {        "component": "body",        "key": "1",        "source": {          "kind": "native",          "field": "first_name"        }      }    ]  }}