Agregar Audiencia a Campaña

Agrega clientes a la audiencia de una campaña. Si algún cliente no existe en el workspace, se crea automáticamente con los datos proporcionados.

POST https://api.platica.mx/v1/campaigns/{campaignId}/audience

Parámetros de la URL

ParámetroTipoDescripciónRequerimiento
campaignIdstringIdentificador único de la campañaobligatorio

Request Body

{
  "clients": [
    { "phoneNumber": "521234567890", "name": "Juan Pérez" },
    { "phoneNumber": "521234567891", "name": "María García" }
  ]
}

Parámetros del Body

ParámetroTipoDescripciónRequerimiento
clientsarrayLista de clientes a agregar. Mínimo 1 elementoobligatorio

Objeto clients[]

ParámetroTipoDescripciónRequerimiento
phoneNumberstringNúmero de teléfono en formato internacionalobligatorio
namestringNombre del clienteobligatorio

Respuesta

{
  "status": "success",
  "message": "2 client(s) added to campaign (1 created, 1 updated)",
  "data": {
    "addedCount": 2,
    "createdCount": 1,
    "updatedCount": 1,
    "clients": [
      { "phoneNumber": "521234567890", "name": "Juan Pérez" },
      { "phoneNumber": "521234567891", "name": "María García" }
    ]
  }
}

Campos de la respuesta

CampoTipoDescripción
addedCountnumberTotal de clientes procesados
createdCountnumberClientes nuevos creados en el workspace
updatedCountnumberClientes existentes actualizados con la etiqueta de la campaña
clientsarrayLista de clientes enviados en el request

Errores comunes

CódigoDescripción
400Body inválido o lista clients vacía
401API Key inválida o expirada
404La campaña no existe o fue eliminada lógicamente
500Error interno al agregar la audiencia

Notas

  • Si el cliente ya existe (mismo phoneNumber), se actualiza su nombre y se le agrega la etiqueta de la campaña.
  • Si el cliente no existe, se crea un registro mínimo con phoneNumber, name, tags, owners, customFields, creationDate y lastUpdate.
  • La etiqueta asignada a los clientes tiene el formato campaign-{campaignId}.
Anterior Obtener Audiencia Siguiente Remover Cliente