Saltar al contenido

Contactos

Consulta de contactos de la organización.

Listar contactos

GET/v1/contacts

Scope necesario: read o full. Una clave full incluye send y read.

Contactos de la organización (sea cual sea el entorno de la clave), del más reciente al más antiguo, con su estado (subscribed, unsubscribed, bounced, complained, blocked). Filtros q, status, listId y tag; paginación por cursor. Solo lectura: no hay escrituras de contactos en la API.

Parámetros

CampoDescripción
cursorstring · query Cursor opaco: usa el nextCursor de la página anterior con los mismos filtros.
limitnumber · query Elementos por página (1-100, 25 por defecto).
qstring · query Busca en email y nombre (contiene, sin mayúsculas ni tildes; 2-254).
statusstring · query Estados separados por comas: subscribed, unsubscribed, bounced, complained, blocked.
listIdstring · query Solo miembros de esa lista.
tagstring · query Solo contactos con esa etiqueta.

Respuestas

  • 200
    CampoDescripción
    data[]object[] · obligatorio
    data[].idstring · obligatorio
    data[].objectstring · obligatoriovalores: contact
    data[].emailstring · obligatorioej.: [email protected]
    data[].firstNamestring | null · obligatorio
    data[].lastNamestring | null · obligatorio
    data[].statusstring · obligatoriovalores: subscribed | unsubscribed | bounced | complained | blocked
    data[].tagsstring[] · obligatorio
    data[].sourceobject · obligatorio
    data[].source.kindstring · obligatoriovalores: manual | import | form | api | unknown
    data[].source.labelstring · obligatorioej.: Importación
    data[].createdAtstring · obligatorio
    data[].lists[]object[] · obligatorio
    data[].lists[].idstring · obligatorio
    data[].lists[].namestring · obligatorio
    nextCursorstring | null · obligatorio

Ejemplo

bash
curl "https://api.vemudo.com/v1/contacts?status=subscribed&limit=50" -H "Authorization: Bearer $VEMUDO_API_KEY"

Consultar un contacto

GET/v1/contacts/{id}

Scope necesario: read o full. Una clave full incluye send y read.

Detalle con campos personalizados, listas (con la fecha de alta), etiquetas y el motivo por el que no está suscrito (statusDetail). No incluye el historial de consentimiento. Id inexistente, de otra organización o mal formado: 404 not_found.

Parámetros

CampoDescripción
idstring · ruta · obligatorio

Respuestas

  • 200
    CampoDescripción
    idstring · obligatorio
    objectstring · obligatoriovalores: contact
    emailstring · obligatorioej.: [email protected]
    firstNamestring | null · obligatorio
    lastNamestring | null · obligatorio
    statusstring · obligatoriovalores: subscribed | unsubscribed | bounced | complained | blocked
    tagsstring[] · obligatorio
    sourceobject · obligatorio
    source.kindstring · obligatoriovalores: manual | import | form | api | unknown
    source.labelstring · obligatorioej.: Importación
    createdAtstring · obligatorio
    attributesobject · obligatorioCampos personalizados (clave: valor).
    unsubscribedAtstring | null · obligatorio
    statusDetailobject | null · obligatorioPor qué no está suscrito (null si lo está). Sin el historial de consentimiento.
    statusDetail.kindstring · obligatoriovalores: unsubscribed | bounced | complained | blocked
    statusDetail.reasonstring | null · obligatorio
    statusDetail.atstring | null · obligatorio
    statusDetail.bounceCodestring | null · obligatorioCódigo SMTP del rebote (solo bounced).
    lists[]object[] · obligatorio
    lists[].idstring · obligatorio
    lists[].namestring · obligatorio
    lists[].addedAtstring · obligatorio
  • 404
    Contacto no encontrado.

Ejemplo

bash
curl https://api.vemudo.com/v1/contacts/$ID \
  -H "Authorization: Bearer $VEMUDO_API_KEY"