Marketo MA (versión preliminar)

Automatización de marketing de Marketo. Esta API proporciona acceso a objetos Marketo, como campañas, programas, clientes potenciales, listas (estáticas y inteligentes), así como recursos del sistema de archivos, como archivos y carpetas.

Este conector está disponible en los siguientes productos y regiones:

Service	Class	Regions
Copilot Studio	Estándar	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas	Estándar	Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD)
Power Apps	Estándar	Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Power Automate	Estándar	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)

Contacto
Nombre	Relaciones para desarrolladores de Marketo
URL	http://developers.marketo.com
Correo Electrónico	developerfeedback@marketo.com

Metadatos del conector
Publicador	Microsoft Inc.
Sitio web	https://www.marketo.com/
Directiva de privacidad	https://documents.marketo.com/legal/privacy/
Términos del servicio	https://go.microsoft.com/fwlink/?linkid=2237005
Categorías	Marketing; Ventas y CRM

Creación de una conexión

El conector admite los siguientes tipos de autenticación:


Predeterminado	Parámetros para crear una conexión.	Todas las regiones	No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre	Tipo	Description	Obligatorio
MunchkinID	cuerda / cadena	Su Marketo MunchkinID (consulte la página De administración)	Cierto
Id. de cliente	cuerda / cadena	Id. de cliente	Cierto
Secreto del cliente	securestring	Secreto del cliente	Cierto

Limitaciones

Nombre	Llamadas	Período de renovación
Llamadas API por conexión	100	60 segundos

Acciones

Actualizar campo de cliente potencial	Actualice los metadatos de un campo de cliente potencial en la instancia de destino. Consulte las reglas de actualización aquí. Permisos necesarios: campo estándar de esquema Read-Write, campo personalizado de esquema Read-Write
Actualizar contenido de archivo	Reemplaza el contenido actual del archivo por la carga incluida. Permisos necesarios: recursos de Read-Write
Actualizar etiqueta de programa	Actualice la etiqueta de programa. Permisos necesarios: recursos de Read-Write
Actualizar metadatos de carpeta	Actualiza los metadatos de una carpeta determinada. Permisos necesarios: recursos de Read-Write
Actualizar metadatos de lista estática	Actualiza los metadatos de un recurso de lista estática. Permisos necesarios: recursos de Read-Write
Actualizar metadatos del programa	Actualiza los metadatos del programa de destino. Permisos necesarios: recursos de Read-Write
Agregar a la lista	Agrega un conjunto determinado de registros de persona a una lista estática de destino. Hay un límite de 300 identificadores de cliente potencial por solicitud. Permisos necesarios: Read-Write cliente potencial
Aprobar programa	Aprueba el programa de destino. Solo es válido para programas de correo electrónico no aprobados. Permisos necesarios: recursos de Read-Write
Campaña de solicitud	Pasa un conjunto de clientes potenciales a una campaña de desencadenador para que se ejecute a través del flujo de la campaña. La campaña designada debe tener una campaña solicitada: desencadenador de API de servicio web y debe estar activa. Mis tokens locales para el programa primario de la campaña se pueden invalidar para que la ejecución personalice el contenido. Se permite un máximo de 100 clientes potenciales por llamada. Permisos necesarios: Ejecutar campaña
Cancelar el trabajo de cliente potencial de exportación	Cancelar el trabajo de exportación. Permisos necesarios: Read-Only cliente potencial
Cancelar trabajo de miembro del programa de exportación	Cancelar el trabajo de exportación. Permisos necesarios: Read-Only cliente potencial
Clientes potenciales de sincronización	Sincroniza una lista de clientes potenciales a la instancia de destino. Permisos necesarios: Read-Write cliente potencial
Clonar lista inteligente	Clona la lista inteligente designada. Permisos necesarios: recurso de Read-Write
Clonar programa	Clona el programa de destino. Permisos necesarios: recursos de Read-Write
Creación de un trabajo de cliente potencial de exportación	Cree un trabajo de exportación para los criterios de búsqueda definidos mediante el parámetro "filter". Request devuelve el "exportId" que se pasa como parámetro en las llamadas posteriores a los puntos de conexión de clientes potenciales de exportación masiva. Use el punto de conexión Exportar trabajo potencial de puesta en cola para poner en cola el trabajo de exportación para su procesamiento. Use el punto de conexión Obtener estado del trabajo de cliente potencial para recuperar el estado del trabajo de exportación. Permisos necesarios: Read-Only cliente potencial
Crear archivo	Crea un nuevo archivo a partir de la carga incluida. Permisos necesarios: recursos de Read-Write
Crear carpeta	Crea una nueva carpeta. Permisos necesarios: recursos de Read-Write
Crear lista estática	Crea una nueva lista estática. Permisos necesarios: recursos de Read-Write
Crear programa	Crea un nuevo programa. Permisos necesarios: recursos de Read-Write
Crear trabajo de miembro del programa de exportación	Cree un trabajo de exportación para los criterios de búsqueda definidos mediante el parámetro "filter". Request devuelve el "exportId" que se pasa como parámetro en llamadas posteriores a los puntos de conexión de miembros del programa de exportación masiva.
Describir lead2	Devuelve la lista de campos que se pueden buscar en los objetos lead de la instancia de destino. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial
Describir miembro del programa	Devuelve metadatos sobre los objetos de miembro del programa en la instancia de destino, incluida una lista de todos los campos disponibles para la interacción a través de las API. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial Nota: Este punto de conexión se ha supercedido. Use el punto de conexión Describir miembro del programa en su lugar.
Describir miembro del programa	Devuelve metadatos sobre los objetos de miembro del programa en la instancia de destino, incluida una lista de todos los campos disponibles para la interacción a través de las API. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial
Descripción del cliente potencial	Devuelve metadatos sobre los objetos de cliente potencial de la instancia de destino, incluida una lista de todos los campos disponibles para la interacción a través de las API. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial Nota: Este punto de conexión se ha supercedido. Use describir el punto de conexión lead2 en su lugar.
Eliminar carpeta	Elimina la carpeta designada. Se producirá un error en la eliminación si la carpeta tiene contenido. Permisos necesarios: recursos de Read-Write
Eliminar clientes potenciales	Elimine una lista de clientes potenciales de la instancia de destino. Permisos necesarios: Read-Write cliente potencial
Eliminar etiqueta de programa	Elimine la etiqueta de programa no necesaria. Permisos necesarios: recursos de Read-Write
Eliminar lista estática	Elimina la lista estática designada. Permisos necesarios: recurso de Read-Write
Eliminar lista inteligente	Elimina la lista inteligente designada. Permisos necesarios: recurso de Read-Write
Eliminar miembros del programa	Elimine una lista de miembros de la instancia de destino. Permisos necesarios: Read-Write cliente potencial
Eliminar programa	Elimina el programa de destino. Es posible que el programa no contenga ningún recurso que esté en uso fuera del programa. Permisos necesarios: recursos de Read-Write
Estado del miembro del programa de sincronización	Cambia el estado de miembro del programa de una lista de clientes potenciales en un programa de destino. Si el miembro no forma parte del programa, el miembro se agrega al programa. Permisos necesarios: Read-Write cliente potencial
identidad	Recupere un token de acceso de Marketo. Las llamadas a este punto de conexión no se cuentan para el límite de llamadas api.
identidad	Recupere un token de acceso de Marketo. Las llamadas a este punto de conexión no se cuentan para el límite de llamadas api.
Importar clientes potenciales	Importa un archivo que contiene registros de datos en la instancia de destino. Permisos necesarios: Read-Write cliente potencial
Importar miembros del programa	Importa un archivo que contiene registros de datos en la instancia de destino. Permisos necesarios: Read-Write cliente potencial
Miembro de la lista	Comprueba si los clientes potenciales son miembros de una lista estática determinada. Permisos necesarios: Read-Write cliente potencial
Obtención de errores de cliente potencial de importación	Devuelve la lista de errores del trabajo por lotes de importación. Permisos necesarios: Read-Write cliente potencial
Obtener advertencias de cliente potencial de importación	Devuelve la lista de advertencias para el trabajo por lotes de importación. Permisos necesarios: Read-Write cliente potencial
Obtener advertencias de miembros del programa de importación	Devuelve la lista de advertencias para el trabajo por lotes de importación. Permisos necesarios: Read-Write cliente potencial
Obtener archivo de cliente potencial de exportación	Devuelve el contenido del archivo de un trabajo de exportación. El trabajo de exportación debe estar en estado "Completado". Use el punto de conexión Obtener estado del trabajo de cliente potencial para recuperar el estado del trabajo de exportación. Permisos necesarios: Read-Only cliente potencial El formato de archivo se especifica mediante una llamada al punto de conexión Crear trabajo de cliente potencial de exportación. A continuación se muestra un ejemplo del formato de archivo predeterminado ("CSV"). `firstName,lastName,email` `Marvin,Gaye,marvin.gaye@motown.com`
Obtener archivo de miembro del programa de exportación	Devuelve el contenido del archivo de un trabajo de exportación. El trabajo de exportación debe estar en estado "Completado". Use el punto de conexión Get Export Member Job Status (Obtener estado del trabajo miembro del programa de exportación) para recuperar el estado del trabajo de exportación. Permisos necesarios: Read-Only cliente potencial El formato de archivo se especifica llamando al punto de conexión Crear trabajo miembro del programa de exportación. A continuación se muestra un ejemplo del formato de archivo predeterminado ("CSV"). `firstName,lastName,email` `Marvin,Gaye,marvin.gaye@motown.com`
Obtener archivo por identificador	Devuelve el registro de archivo para el identificador especificado. Permisos necesarios: recursos de Read-Only, recursos Read-Write activos
Obtener archivo por nombre	Devuelve registros de archivos para el nombre especificado. Permisos necesarios: recursos de Read-Only, recursos de Read-Write
Obtener archivos	Devuelve los archivos de la carpeta especificada. Permisos necesarios: recursos de Read-Only, recursos de Read-Write
Obtener campaña por identificador	Devuelve el registro de una campaña por su identificador. Permisos necesarios: Read-Only Campañas, campañas de Read-Write Nota: Este punto de conexión se ha supercedido. Use el punto de conexión Obtener campaña inteligente por identificador en su lugar.
Obtener campañas	Devuelve una lista de registros de campaña. Permisos necesarios: campañas de Read-Only, campañas de Read-Write Nota: Este punto de conexión se ha supercedido. Use el punto de conexión Obtener campañas inteligentes en su lugar.
Obtener campo de cliente potencial por nombre	Recupera los metadatos del campo de cliente potencial único. Permisos necesarios: campo estándar de esquema Read-Write, campo personalizado de esquema Read-Write
Obtener carpeta por identificador	Devuelve el registro de carpeta con el identificador especificado. Permisos necesarios: Read-Only activos, Read-Write activos
Obtener carpeta por nombre	Devuelve un registro de carpeta para el nombre especificado. Permisos necesarios: recursos de Read-Only, recursos de Read-Write
Obtener carpetas	Recupera las carpetas secundarias desde una carpeta raíz determinada. Permisos necesarios: recursos de Read-Only, recursos de Read-Write
Obtener cliente potencial por identificador	Recupera un único registro de cliente potencial a través de su identificador de Marketo. Permisos necesarios: Read-Only cliente potencial, Read-Write cliente potencial
Obtener clientes potenciales por identificador de lista	Recupera los registros de persona que son miembros de la lista estática especificada. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial
Obtener clientes potenciales por identificador de lista	Recupera los registros de persona que son miembros de la lista estática especificada. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial
Obtener clientes potenciales por identificador de programa	Recupera una lista de clientes potenciales que son miembros del programa designado. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial
Obtener clientes potenciales por tipo de filtro	Devuelve una lista de hasta 300 clientes potenciales en función de una lista de valores de un campo determinado. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial
Obtener contenido de la carpeta	Devuelve registros para el contenido de una carpeta determinada. Permisos necesarios: recursos de Read-Only, recursos de Read-Write
Obtener el campo miembro del programa por nombre	Recupera metadatos para el campo miembro de un solo programa. Permisos necesarios: campo estándar de esquema Read-Write, campo personalizado de esquema Read-Write
Obtener el estado del cliente potencial de importación	Devuelve el estado de un trabajo por lotes de importación. Permisos necesarios: Read-Write cliente potencial
Obtener el estado del miembro del programa de importación	Devuelve el estado de un trabajo por lotes de importación. Permisos necesarios: Read-Write cliente potencial
Obtener el estado del trabajo de cliente potencial de exportación	Devuelve el estado de un trabajo de exportación. El estado del trabajo está disponible durante 30 días después de que se alcanzó el estado Completado o Erróneo. Permisos necesarios: Read-Only cliente potencial
Obtener el estado del trabajo del miembro del programa de exportación	Devuelve el estado de un trabajo de exportación. El estado del trabajo está disponible durante 30 días después de que se alcanzó el estado Completado o Erróneo. Permisos necesarios: Read-Only cliente potencial
Obtener errores de miembro del programa de importación	Devuelve la lista de errores del trabajo por lotes de importación. Permisos necesarios: Read-Write cliente potencial
Obtener lista estática por identificador	Recupera un registro de lista estática por su identificador. Permisos necesarios: Read-Asset o Read-Write recurso
Obtener lista estática por nombre	Recupera un registro de lista estática por su nombre. Permisos necesarios: Read-Asset o recurso de Read-Write
Obtener lista inteligente por identificador	Recupera un registro de lista inteligente por su identificador. Permisos necesarios: Read-Asset o Read-Write recurso
Obtener lista inteligente por identificador de programa	Recupera un registro de lista inteligente por su identificador de programa de correo electrónico. Permisos necesarios: Read-Asset o Read-Write recurso
Obtener lista inteligente por nombre	Recupera un registro de lista inteligente por su nombre. Permisos necesarios: Read-Asset o recurso de Read-Write
Obtener lista por identificador	Devuelve un registro de lista por su identificador. Permisos necesarios: Read-Only cliente potencial, Read-Write cliente potencial
Obtener listas	Devuelve un conjunto de registros de lista estáticos basados en parámetros de filtro especificados. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial
Obtener listas estáticas	Recupera una lista de registros de lista estática. Permisos necesarios: Read-Asset o recurso de Read-Write
Obtener listas inteligentes	Recupera una lista de registros de lista inteligente creados por el usuario. Permisos necesarios: Read-Asset o recurso de Read-Write
Obtener miembros del programa	Devuelve una lista de hasta 300 miembros del programa en una lista de valores de un campo determinado. Si especifica un filterType que es un campo personalizado, el tipo de datos del campo personalizado debe ser "string" o "integer". Si especifica un filterType distinto de "leadId", la solicitud puede procesar un máximo de 100 000 registros de miembros del programa. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial
Obtener programa por identificador	Recupera el registro del programa para el identificador especificado. Permisos necesarios: recursos de Read-Only, recursos de Read-Write activos
Obtener programa por nombre	Recupera el registro del programa para el nombre especificado. Permisos necesarios: recursos de Read-Only, recursos de Read-Write
Obtener programas	Recupera la lista de programas accesibles de la instancia de destino. Permisos necesarios: recursos de Read-Only, recursos de Read-Write
Obtener programas por etiqueta	Recupera una lista de programas que coinciden con el tipo de etiqueta y los valores de etiqueta especificados. Permisos necesarios: recursos de Read-Only, recursos de Read-Write
Obtener trabajos de cliente potencial de exportación	Devuelve una lista de trabajos de exportación creados en los últimos 7 días. Permisos necesarios: Read-Only cliente potencial
Obtener trabajos de miembro del programa de exportación	Devuelve una lista de trabajos de exportación creados en los últimos 7 días. Permisos necesarios: Read-Only cliente potencial
Poner en cola el trabajo de cliente potencial de exportación	Poner en cola el trabajo de exportación. Esto colocará el trabajo de exportación en cola e iniciará el trabajo cuando los recursos informáticos estén disponibles. El trabajo de exportación debe estar en estado "Creado". Use el punto de conexión Obtener estado del trabajo de cliente potencial para recuperar el estado del trabajo de exportación. Permisos necesarios: Read-Only cliente potencial
Poner en cola el trabajo de miembro del programa de exportación	Poner en cola el trabajo de exportación. Esto colocará el trabajo de exportación en cola e iniciará el trabajo cuando los recursos informáticos estén disponibles. El trabajo de exportación debe estar en estado "Creado".
Programa no aprobado	No aprueba el programa de destino. Solo es válido para programas de correo electrónico aprobados. Permisos necesarios: recursos de Read-Write
Programación de campaña	Programa de forma remota una campaña por lotes para que se ejecute en un momento dado. Mis tokens locales para el programa primario de la campaña se pueden invalidar para que la ejecución personalice el contenido. Al usar el parámetro "cloneToProgramName" descrito a continuación, este punto de conexión se limita a 20 llamadas al día. Permisos necesarios: Ejecutar campaña
Push Lead to Marketo	Upserts un cliente potencial y genera una actividad Push Lead to Marketo. Permisos necesarios: Read-Write cliente potencial
Quitar de la lista	Quita un conjunto determinado de registros de persona de una lista estática de destino. Permisos necesarios: Read-Write cliente potencial
Sincronizar datos de miembros del programa	Cambia los datos de los miembros del programa de una lista de clientes potenciales en un programa de destino. Solo los miembros existentes del programa pueden tener sus datos modificados con esta API. Permisos necesarios: Read-Write cliente potencial

Actualizar campo de cliente potencial

Id. de la operación:: updateLeadFieldUsingPOST

Actualice los metadatos de un campo de cliente potencial en la instancia de destino. Consulte las reglas de actualización aquí. Permisos necesarios: campo estándar de esquema Read-Write, campo personalizado de esquema Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre de API del campo de cliente potencial	fieldApiName	True	string	Nombre de API del campo de cliente potencial
Nombre para mostrar	displayName		string	Nombre para mostrar de la interfaz de usuario del campo
descripción	description		string	Descripción del campo
isHidden	isHidden		boolean	Si se establece en true, el campo está oculto. El valor predeterminado es false
isHtmlEncodingInEmail	isHtmlEncodingInEmail		boolean	Si se establece en true, el campo se codifica como HTML en el correo electrónico. El valor predeterminado es verdadero
isSensitive	isSensitive		boolean	Si se establece en true, el campo se marca como confidencial. El valor predeterminado es false

Devoluciones

Body: ResponseOfUpdateLeadField

Actualizar contenido de archivo

Id. de la operación:: updateContentUsingPOST

Reemplaza el contenido actual del archivo por la carga incluida. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del archivo	id	True	integer	Identificador del archivo en la base de datos
archivo	file	True	string	Archivo de varias partes. Contenido del archivo.
id	id	True	integer	Identificador del archivo

Devoluciones

Body: ResponseOfFileResponse

Actualizar etiqueta de programa

Id. de la operación:: updateProgramTagUsingPOST

Actualice la etiqueta de programa. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id. de programa	id	True	integer	id
Tipo de etiqueta de programa	tagType	True	string	Tipo de etiqueta de programa
Valor de la etiqueta de programa	tagValue	True	string	Valor de la etiqueta de programa

Devoluciones

Body: ResponseOfIdResponse

Actualizar metadatos de carpeta

Id. de la operación:: updateFolderUsingPOST

Actualiza los metadatos de una carpeta determinada. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la carpeta que se va a actualizar	id	True	integer	Identificador de la carpeta que se va a actualizar
descripción	description		string	Descripción del recurso
isArchive	isArchive		boolean	Indica si la carpeta está archivada o no. Al alternar este valor, se cambiará el estado de archivo de la carpeta.
nombre	name		string	Nombre de la carpeta
type	type	True	string	Tipo de carpeta. 'Carpeta' o 'Programa'

Devoluciones

Body: ResponseOfFolderResponse

Actualizar metadatos de lista estática

Id. de la operación:: updateStaticListUsingPOST

Actualiza los metadatos de un recurso de lista estática. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la lista estática que se va a actualizar	id	True	integer	Identificador de la lista estática que se va a actualizar
descripción	description		string	Descripción de la lista estática
nombre	name		string	Nombre de la lista estática

Devoluciones

Body: ResponseOfStaticListResponse

Actualizar metadatos del programa

Id. de la operación:: updateProgramUsingPOST

Actualiza los metadatos del programa de destino. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id. de programa	id	True	integer	id
costo	cost	True	integer	Importe del costo
nota	note		string	Notas sobre el costo
startDate	startDate	True	date-time	Fecha de inicio del costo del período
costsDestructiveUpdate	costsDestructiveUpdate		boolean	Establezca true para destruir los costos existentes y reemplazarlos por los costos especificados.
descripción	description		string	Descripción actualizada del programa
fecha de finalización	endDate		string	Fecha de finalización del programa. Aplicable a los programas de tipo evento, correo electrónico y seminario web
nombre	name		string	Nombre del programa
startDate	startDate		string	Fecha de inicio del programa. Aplicable a los programas de eventos, correo electrónico y tipo de seminario web
tagType	tagType		string	Tipo de etiqueta de programa
tagValue	tagValue		string	Valor de la etiqueta

Devoluciones

Body: ResponseOfProgramResponse

Agregar a la lista

Id. de la operación:: addLeadsToListUsingPOST

Agrega un conjunto determinado de registros de persona a una lista estática de destino. Hay un límite de 300 identificadores de cliente potencial por solicitud. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la lista de destino	listId	True	integer	Identificador de la lista de destino
id	id	True	integer	Identificador entero único de un registro de cliente potencial
Lista separada por comas de identificadores de cliente potencial que se van a agregar a la lista	id		array	Lista separada por comas de identificadores de cliente potencial que se van a agregar a la lista

Devoluciones

Body: ResponseOfListOperationOutputData

Aprobar programa

Id. de la operación:: approveProgramUsingPOST

Aprueba el programa de destino. Solo es válido para programas de correo electrónico no aprobados. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id. de programa	id	True	integer	id

Devoluciones

Body: ResponseOfIdResponse

Campaña de solicitud

Id. de la operación:: triggerCampaignUsingPOST

Pasa un conjunto de clientes potenciales a una campaña de desencadenador para que se ejecute a través del flujo de la campaña. La campaña designada debe tener una campaña solicitada: desencadenador de API de servicio web y debe estar activa. Mis tokens locales para el programa primario de la campaña se pueden invalidar para que la ejecución personalice el contenido. Se permite un máximo de 100 clientes potenciales por llamada. Permisos necesarios: Ejecutar campaña

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la campaña que se va a desencadenar	campaignId	True	integer	Identificador de la campaña que se va a desencadenar
id	id	True	integer	Identificador entero único de un registro de cliente potencial
nombre	name	True	string	Nombre del token. Debe tener el formato "{{my.name}}"
value	value	True	string	Valor del token

Devoluciones

Body: ResponseOfCampaign

Cancelar el trabajo de cliente potencial de exportación

Id. de la operación:: cancelExportLeadsUsingPOST

Cancelar el trabajo de exportación. Permisos necesarios: Read-Only cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de exportación.	exportId	True	string	Identificador del trabajo por lotes de exportación.

Devoluciones

Body: ResponseOfExportResponse

Cancelar trabajo de miembro del programa de exportación

Id. de la operación:: cancelExportProgramMembersUsingPOST

Cancelar el trabajo de exportación. Permisos necesarios: Read-Only cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de exportación.	exportId	True	string	Identificador del trabajo por lotes de exportación.

Devoluciones

Body: ResponseOfExportResponse

Clientes potenciales de sincronización

Id. de la operación:: syncLeadUsingPOST

Sincroniza una lista de clientes potenciales a la instancia de destino. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
acción	action		string	Tipo de operación de sincronización que se va a realizar. El valor predeterminado es createOrUpdate si no se establece
asyncProcessing	asyncProcessing		boolean	Si se establece en true, la llamada devolverá inmediatamente.
id	id		integer	Identificador entero único de un registro de cliente potencial
acquiredBy	acquiredBy		boolean	Si el programa primario adquirió el cliente potencial
isExhausted	isExhausted		boolean	Si el cliente potencial se agota actualmente en el flujo, si procede
membershipDate	membershipDate	True	string	Fecha en que el cliente potencial se convirtió en miembro del programa por primera vez
nurtureCadence	nurtureCadence		string	Cadencia de la secuencia primaria si procede
progressionStatus	progressionStatus	True	string	Estado del programa del cliente potencial en el programa primario
reachedSuccess	reachedSuccess		boolean	Si el cliente potencial está en un estado correcto en el programa primario
flujo	stream		string	Stream that the lead is a member of, if the parent program is an engagement program
código	code	True	string	Código entero del motivo
Mensaje	message	True	string	Mensaje que describe el motivo del estado de la operación
estado	status		string	Estado de la operación realizada en el registro
lookupField	lookupField		string	Campo en el que se va a desduplicar. El campo debe estar presente en cada registro de cliente potencial de la entrada. El valor predeterminado es enviar un correo electrónico si no se establece
partitionName	partitionName		string	Nombre de la partición en la que se va a operar, si procede. Debe establecerse siempre que sea posible, al interactuar con una instancia en la que se habilitan las particiones.

Devoluciones

Body: ResponseOfLead

Clonar lista inteligente

Id. de la operación:: cloneSmartListUsingPOST

Clona la lista inteligente designada. Permisos necesarios: recurso de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de lista inteligente que se va a clonar	id	True	integer	Identificador de lista inteligente que se va a clonar
nombre	name	True	string	Nombre de la lista inteligente clonada
id	id	True	integer	Identificador de la carpeta
type	type	True	string	Tipo de carpeta
descripción	description		string	Descripción de la lista inteligente clonada

Devoluciones

Body: ResponseOfSmartListResponse

Clonar programa

Id. de la operación:: cloneProgramUsingPOST

Clona el programa de destino. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id. de programa	id	True	integer	id
descripción	description		string
id	id	True	integer	Identificador de la carpeta
type	type	True	string	Tipo de carpeta
nombre	name	True	string	Nombre del programa. Máximo de 255 caracteres

Devoluciones

Body: ResponseOfProgramResponse

Creación de un trabajo de cliente potencial de exportación

Id. de la operación:: createExportLeadsUsingPOST

Cree un trabajo de exportación para los criterios de búsqueda definidos mediante el parámetro "filter". Request devuelve el "exportId" que se pasa como parámetro en las llamadas posteriores a los puntos de conexión de clientes potenciales de exportación masiva. Use el punto de conexión Exportar trabajo potencial de puesta en cola para poner en cola el trabajo de exportación para su procesamiento. Use el punto de conexión Obtener estado del trabajo de cliente potencial para recuperar el estado del trabajo de exportación. Permisos necesarios: Read-Only cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
nombre	name	True	string	Nombre de la API REST para el campo de encabezado
value	value	True	string	Valor para el campo de encabezado
fields	fields	True	array of string	Lista separada por comas de campos que se van a incluir en el archivo
endAt	endAt		string	Filtro de fin del intervalo de fechas (formato ISO 8601)
startAt	startAt		string	Inicio del filtro de intervalo de fechas (formato ISO-8601)
smartListId	smartListId	True	integer	Identificador de la lista inteligente para recuperar clientes potenciales de
smartListName	smartListName	True	string	Nombre de la lista inteligente para recuperar clientes potenciales de
staticListId	staticListId	True	integer	Identificador de la lista estática para recuperar clientes potenciales de
staticListName	staticListName	True	string	Nombre de la lista estática para recuperar clientes potenciales de
format	format		string	Formato de archivo para crear("CSV", "TSV", "SSV"). El valor predeterminado es "CSV"

Devoluciones

Body: ResponseOfExportResponse

Crear archivo

Id. de la operación:: createFileUsingPOST

Crea un nuevo archivo a partir de la carga incluida. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
descripción	description		string	Descripción del recurso
archivo	file	True	string	Archivo de varias partes. Contenido del archivo.
id	id	True	integer	Identificador de la carpeta
type	type	True	string	Tipo de carpeta
insertOnly	insertOnly		boolean	Si se produce un error en las llamadas si ya hay un archivo existente con el mismo nombre
nombre	name	True	string	Nombre del archivo

Devoluciones

Body: ResponseOfFileResponse

Crear carpeta

Id. de la operación:: createFolderUsingPOST

Crea una nueva carpeta. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
descripción	description		string	Descripción del recurso
nombre	name	True	string	Nombre de la carpeta
id	id	True	integer	Identificador de la carpeta
type	type	True	string	Tipo de carpeta

Devoluciones

Body: ResponseOfFolderResponse

Crear lista estática

Id. de la operación:: createStaticListUsingPOST

Crea una nueva lista estática. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
descripción	description		string	Descripción de la lista estática
nombre	name	True	string	Nombre de la lista estática
id	id	True	integer	Identificador de la carpeta
type	type	True	string	Tipo de carpeta

Devoluciones

Body: ResponseOfStaticListResponse

Crear programa

Id. de la operación:: createProgramUsingPOST

Crea un nuevo programa. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Canal	channel	True	string	Canal del programa
costo	cost	True	integer	Importe del costo
nota	note		string	Notas sobre el costo
startDate	startDate	True	date-time	Fecha de inicio del costo del período
descripción	description		string
id	id	True	integer	Identificador de la carpeta
type	type	True	string	Tipo de carpeta
nombre	name	True	string	Nombre del programa
tagType	tagType		string	Tipo de etiqueta de programa
tagValue	tagValue		string	Valor de la etiqueta
type	type	True	string	Tipo del programa

Devoluciones

Body: ResponseOfProgramResponse

Crear trabajo de miembro del programa de exportación

Id. de la operación:: createExportProgramMembersUsingPOST

Cree un trabajo de exportación para los criterios de búsqueda definidos mediante el parámetro "filter". Request devuelve el "exportId" que se pasa como parámetro en llamadas posteriores a los puntos de conexión de miembros del programa de exportación masiva.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
nombre	name	True	string	Nombre de la API REST para el campo de encabezado
value	value	True	string	Valor para el campo de encabezado
fields	fields	True	array of string	Lista separada por comas de campos que se van a incluir en el archivo
programId	programId	True	integer	Identificador del programa del que recuperar miembros. No se puede usar en combinación con el filtro "programIds"
programIds	programIds	True	array of integer	Matriz de identificadores de programa de la que se van a recuperar miembros. No se puede usar en combinación con el filtro "programId"
isExhausted	isExhausted		boolean	Filtrar los registros de pertenencia a programas para personas que han agotado el contenido
nurtureCadence	nurtureCadence		string	Filtrar los registros de pertenencia a programas para una cadencia de crianza determinada
statusNames	statusNames		array of string	Matriz de nombres de estado de miembro del programa. Puede ser predeterminado o definido por el usuario. Varios nombres de estado son ORed juntos.
endAt	endAt		string	Filtro de fin del intervalo de fechas (formato ISO 8601)
startAt	startAt		string	Inicio del filtro de intervalo de fechas (formato ISO-8601)
format	format		string	Formato de archivo para crear("CSV", "TSV", "SSV"). El valor predeterminado es "CSV"

Devoluciones

Body: ResponseOfExportResponse

Describir lead2

Id. de la operación:: describeUsingGET_6

Devuelve la lista de campos que se pueden buscar en los objetos lead de la instancia de destino. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial

Devoluciones

Body: ResponseOfLeadAttribute2

Describir miembro del programa

Id. de la operación:: describeProgramMemberUsingGET

Devuelve metadatos sobre los objetos de miembro del programa en la instancia de destino, incluida una lista de todos los campos disponibles para la interacción a través de las API. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial

Nota: Este punto de conexión se ha supercedido. Use el punto de conexión Describir miembro del programa en su lugar.

Devoluciones

Body: ResponseOfProgramMemberAttributes

Describir miembro del programa

Id. de la operación:: describeProgramMemberUsingGET2

Devoluciones

Body: ResponseOfProgramMemberAttributes2

Descripción del cliente potencial

Id. de la operación:: describeUsingGET_2

Devuelve metadatos sobre los objetos de cliente potencial de la instancia de destino, incluida una lista de todos los campos disponibles para la interacción a través de las API. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial

Nota: Este punto de conexión se ha supercedido. Use describir el punto de conexión lead2 en su lugar.

Devoluciones

Body: ResponseOfLeadAttribute

Eliminar carpeta

Id. de la operación:: deleteFolderUsingPOST

Elimina la carpeta designada. Se producirá un error en la eliminación si la carpeta tiene contenido. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la carpeta que se va a eliminar	id	True	integer	Identificador de la carpeta que se va a eliminar
tipo de carpeta	type	True	string	type

Devoluciones

Body: ResponseOfIdResponse

Eliminar clientes potenciales

Id. de la operación:: deleteLeadsUsingPOST

Elimine una lista de clientes potenciales de la instancia de destino. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	integer	Identificador entero único de un registro de cliente potencial
Se puede especificar el parámetro si el cuerpo de la solicitud está vacío.	id		array	Se puede especificar el parámetro si el cuerpo de la solicitud está vacío. Se pueden especificar varios identificadores de cliente potencial. Por ejemplo, id=1,2,3,2342

Devoluciones

Body: ResponseOfLead

Eliminar etiqueta de programa

Id. de la operación:: deleteProgramTagUsingPOST

Elimine la etiqueta de programa no necesaria. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id. de programa	id	True	integer	id
Tipo de etiqueta de programa	tagType	True	string	Tipo de etiqueta de programa

Devoluciones

Body: ResponseOfIdResponse

Eliminar lista estática

Id. de la operación:: deleteStaticListByIdUsingPOST

Elimina la lista estática designada. Permisos necesarios: recurso de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la lista estática que se va a eliminar	id	True	integer	Identificador de la lista estática que se va a eliminar

Devoluciones

Body: ResponseOfIdResponse

Eliminar lista inteligente

Id. de la operación:: deleteSmartListByIdUsingPOST

Elimina la lista inteligente designada. Permisos necesarios: recurso de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la lista inteligente que se va a eliminar	id	True	integer	Identificador de la lista inteligente que se va a eliminar

Devoluciones

Body: ResponseOfIdResponse

Eliminar miembros del programa

Id. de la operación:: deleteProgramMemberUsingPOST

Elimine una lista de miembros de la instancia de destino. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del programa de destino.	programId	True	integer	Identificador del programa de destino.
leadId	leadId	True	integer	Identificador entero único de un registro de cliente potencial

Devoluciones

Body: ResponseOfProgramMemberDelete

Eliminar programa

Id. de la operación:: deleteProgramUsingPOST

Elimina el programa de destino. Es posible que el programa no contenga ningún recurso que esté en uso fuera del programa. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id. de programa	id	True	integer	id

Devoluciones

Body: ResponseOfIdResponse

Estado del miembro del programa de sincronización

Id. de la operación:: syncProgramMemberStatusUsingPOST

Cambia el estado de miembro del programa de una lista de clientes potenciales en un programa de destino. Si el miembro no forma parte del programa, el miembro se agrega al programa. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del programa de destino.	programId	True	integer	Identificador del programa de destino.
statusName	statusName	True	string	Estado del miembro del programa
leadId	leadId	True	integer	Identificador entero único de un registro de cliente potencial

Devoluciones

Body: ResponseOfProgramMemberStatus

identidad

Id. de la operación:: identityUsingGET

Recupere un token de acceso de Marketo. Las llamadas a este punto de conexión no se cuentan para el límite de llamadas api.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ClientID para la API REST de Marketo	client_id	True	string	Id. de cliente desde el menú Launchpoint de integración > de administración>.
Secreto de cliente para la API REST de Marketo	client_secret	True	string	Secreto de cliente del menú Launchpoint de integración > de administración>.
Tipo de concesión. Nuestras credenciales de cliente de casos	grant_type	True	string	Tipo de concesión.

Devoluciones

Body: ResponseOfIdentity

identidad

Id. de la operación:: identityUsingPOST

Recupere un token de acceso de Marketo. Las llamadas a este punto de conexión no se cuentan para el límite de llamadas api.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ClientID para la API REST de Marketo	client_id	True	string	Id. de cliente desde el menú Launchpoint de integración > de administración>.
Secreto de cliente para la API REST de Marketo	client_secret	True	string	Secreto de cliente del menú Launchpoint de integración > de administración>.
Tipo de concesión. Nuestras credenciales de cliente de casos	grant_type	True	string	Tipo de concesión.

Devoluciones

Body: ResponseOfIdentity

Importar clientes potenciales

Id. de la operación:: importLeadUsingPOST

Importa un archivo que contiene registros de datos en la instancia de destino. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Importar formato de archivo.	format	True	string	Importar formato de archivo.
Campo que se va a usar para la desduplicación. Campos personalizados (cadena, correo electrónico, entero)	lookupField		string	Campo que se va a usar para la desduplicación. Se admiten campos personalizados (cadena, correo electrónico, entero) y los siguientes tipos de campo: id, cookies, correo electrónico, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. El valor predeterminado es el correo electrónico. Nota: Puede usar el identificador para las operaciones de solo actualización.
Nombre de la partición de cliente potencial a la que se va a importar.	partitionName		string	Nombre de la partición de cliente potencial a la que se va a importar.
Identificador de la lista estática en la que se va a importar.	listId		integer	Identificador de la lista estática en la que se va a importar.
Archivo que contiene los registros de datos que se van a importar.	file	True	file	Archivo que contiene los registros de datos que se van a importar.

Devoluciones

Body: ResponseOfImportLeadResponse

Importar miembros del programa

Id. de la operación:: importProgramMemberUsingPOST

Importa un archivo que contiene registros de datos en la instancia de destino. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del programa al que se van a agregar miembros.	programId	True	string	Identificador del programa al que se van a agregar miembros.
Estado del miembro del programa para los miembros que se van a agregar.	programMemberStatus	True	string	Estado del miembro del programa para los miembros que se van a agregar.
Importar formato de archivo.	format	True	string	Importar formato de archivo.
Archivo que contiene los registros de datos que se van a importar.	file	True	file	Archivo que contiene los registros de datos que se van a importar.

Devoluciones

Body: ResponseOfImportProgramMemberResponse

Miembro de la lista

Id. de la operación:: areLeadsMemberOfListUsingGET

Comprueba si los clientes potenciales son miembros de una lista estática determinada. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la lista estática con la que se va a comprobar	listId	True	integer	Identificador de la lista estática con la que se va a comprobar
id	id	True	integer	Identificador entero único de un registro de cliente potencial
Lista separada por comas de identificadores de cliente potencial que se van a comprobar	id		array	Lista separada por comas de identificadores de cliente potencial que se van a comprobar

Devoluciones

Body: ResponseOfListOperationOutputData

Obtención de errores de cliente potencial de importación

Id. de la operación:: getImportLeadFailuresUsingGET

Devuelve la lista de errores del trabajo por lotes de importación. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de importación.	batchId	True	integer	Identificador del trabajo por lotes de importación.

Devoluciones

response: object

Obtener advertencias de cliente potencial de importación

Id. de la operación:: getImportLeadWarningsUsingGET

Devuelve la lista de advertencias para el trabajo por lotes de importación. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de importación.	batchId	True	integer	Identificador del trabajo por lotes de importación.

Devoluciones

response: object

Obtener advertencias de miembros del programa de importación

Id. de la operación:: getImportProgramMemberWarningsUsingGET

Devuelve la lista de advertencias para el trabajo por lotes de importación. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de importación.	batchId	True	integer	Identificador del trabajo por lotes de importación.

Devoluciones

response: object

Obtener archivo de cliente potencial de exportación

Id. de la operación:: getExportLeadsFileUsingGET

Devuelve el contenido del archivo de un trabajo de exportación. El trabajo de exportación debe estar en estado "Completado". Use el punto de conexión Obtener estado del trabajo de cliente potencial para recuperar el estado del trabajo de exportación. Permisos necesarios: Read-Only cliente potencial

El formato de archivo se especifica mediante una llamada al punto de conexión Crear trabajo de cliente potencial de exportación. A continuación se muestra un ejemplo del formato de archivo predeterminado ("CSV").

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de exportación.	exportId	True	string	Identificador del trabajo por lotes de exportación.
Para admitir la recuperación parcial de datos extraídos	Range		string	Para admitir la recuperación parcial de datos extraídos, se puede especificar el encabezado HTTP "Range" de tipo "bytes". Consulte RFC 2616 "Solicitudes de recuperación de intervalos" para obtener más información. Si no se establece el encabezado, se devolverá todo el contenido.

Devoluciones

response: object

Obtener archivo de miembro del programa de exportación

Id. de la operación:: getExportProgramMembersFileUsingGET

Devuelve el contenido del archivo de un trabajo de exportación. El trabajo de exportación debe estar en estado "Completado". Use el punto de conexión Get Export Member Job Status (Obtener estado del trabajo miembro del programa de exportación) para recuperar el estado del trabajo de exportación. Permisos necesarios: Read-Only cliente potencial

El formato de archivo se especifica llamando al punto de conexión Crear trabajo miembro del programa de exportación. A continuación se muestra un ejemplo del formato de archivo predeterminado ("CSV").

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de exportación.	exportId	True	string	Identificador del trabajo por lotes de exportación.
Para admitir la recuperación parcial de datos extraídos.	Range		string	Para admitir la recuperación parcial de datos extraídos, se puede especificar el encabezado HTTP "Range" de tipo "bytes". Consulte RFC 2616 "Solicitudes de recuperación de intervalos" para obtener más información. Si no se establece el encabezado, se devolverá todo el contenido.

Devoluciones

response: object

Obtener archivo por identificador

Id. de la operación:: getFileByIdUsingGET

Devuelve el registro de archivo para el identificador especificado. Permisos necesarios: recursos de Read-Only, recursos Read-Write activos

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del archivo	id	True	integer	Identificador del archivo en la base de datos

Devoluciones

Body: ResponseOfFileResponse

Obtener archivo por nombre

Id. de la operación:: getFileByNameUsingGET

Devuelve registros de archivos para el nombre especificado. Permisos necesarios: recursos de Read-Only, recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
El nombre del archivo	name	True	string	Nombre del archivo

Devoluciones

Body: ResponseOfFileResponse

Obtener archivos

Id. de la operación:: getFilesUsingGET

Devuelve los archivos de la carpeta especificada. Permisos necesarios: recursos de Read-Only, recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	integer	Identificador de la carpeta
type	type	True	string	Tipo de carpeta
maxReturn	maxReturn		integer	Número máximo de canales que se van a devolver. Máximo 200, valor predeterminado 20
offset	offset		integer	Desplazamiento entero para paginación
Carpeta donde se va a colocar el archivo	folder		string	Representación JSON de la carpeta primaria, con miembros 'id' y 'type' que pueden ser 'Folder' o 'Program'

Devoluciones

Body: ResponseOfFileResponse

Obtener campaña por identificador

Id. de la operación:: getCampaignByIdUsingGET

Devuelve el registro de una campaña por su identificador. Permisos necesarios: Read-Only Campañas, campañas de Read-Write

Nota: Este punto de conexión se ha supercedido. Use el punto de conexión Obtener campaña inteligente por identificador en su lugar.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
campaignId	campaignId	True	integer	campaignId

Devoluciones

Body: ResponseOfCampaign

Obtener campañas

Id. de la operación:: getCampaignsUsingGET

Devuelve una lista de registros de campaña. Permisos necesarios: campañas de Read-Only, campañas de Read-Write

Nota: Este punto de conexión se ha supercedido. Use el punto de conexión Obtener campañas inteligentes en su lugar.

Parámetros

Nombre	Clave	Tipo	Description
Lista separada por comas de identificadores de campaña para devolver registros para	id	array	Lista separada por comas de identificadores de campaña para devolver registros para
Lista separada por comas de nombres en los que filtrar	name	array	Lista separada por comas de nombres en los que filtrar
Lista separada por comas de nombres de programa para filtrar.	programName	array	Lista separada por comas de nombres de programa para filtrar. Si se establece, filtrará por solo campañas que sean niños de los programas designados.
Lista separada por comas de nombres de área de trabajo en los que filtrar.	workspaceName	array	Lista separada por comas de nombres de área de trabajo en los que filtrar. Si se establece, solo devolverá campañas en las áreas de trabajo especificadas.
Número máximo de registros que se van a devolver. El valor máximo y predeterminado es 300.	batchSize	integer	Número máximo de registros que se van a devolver. El valor máximo y predeterminado es 300.
Este punto de conexión devolverá un token. Consulta Paging Tokens (Tokens de paginación) para obtener más información.	nextPageToken	string	Este punto de conexión devolverá un token si el conjunto de resultados es mayor que el tamaño del lote y se puede pasar en una llamada posterior a través de este parámetro. Consulta Paging Tokens (Tokens de paginación) para obtener más información.
si es Desencadenador solicitado y el origen es api de servicio web	isTriggerable	boolean	Establézcalo en true para devolver campañas activas que tienen un desencadenador Solicitado y el origen es la API de servicio web.

Devoluciones

Body: ResponseOfCampaign

Obtener campo de cliente potencial por nombre

Id. de la operación:: getLeadFieldByNameUsingGET

Recupera los metadatos del campo de cliente potencial único. Permisos necesarios: campo estándar de esquema Read-Write, campo personalizado de esquema Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre de API del campo de cliente potencial	fieldApiName	True	string	Nombre de API del campo de cliente potencial

Devoluciones

Body: ResponseOfLeadField

Obtener carpeta por identificador

Id. de la operación:: getFolderByIdUsingGET

Devuelve el registro de carpeta con el identificador especificado. Permisos necesarios: Read-Only activos, Read-Write activos

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la carpeta que se va a recuperar	id	True	integer	Identificador de la carpeta que se va a recuperar
Tipo de la carpeta (Programa o Carpeta)	type	True	string	Tipo de carpeta. 'Carpeta' o 'Programa'

Devoluciones

Body: ResponseOfFolderResponse

Obtener carpeta por nombre

Id. de la operación:: getFolderByNameUsingGET

Devuelve un registro de carpeta para el nombre especificado. Permisos necesarios: recursos de Read-Only, recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre de la carpeta	name	True	string	Nombre de la carpeta. No aplicable a los programas
Tipo de la carpeta (Programa o Carpeta)	type		string	Tipo de carpeta. 'Carpeta' o 'Programa'
Referencia de la carpeta primaria	root		string	Referencia de carpetas primarias
El nombre del espacio de trabajo	workSpace		string	Nombre del área de trabajo

Devoluciones

Body: ResponseOfFolderResponse

Obtener carpetas

Id. de la operación:: getFolderUsingGET

Recupera las carpetas secundarias desde una carpeta raíz determinada. Permisos necesarios: recursos de Read-Only, recursos de Read-Write

Parámetros

Nombre	Clave	Tipo	Description
Referencia de carpetas primarias	root	string	Referencia de carpetas primarias
Profundidad máxima de carpeta que recorrer, valor predeterminado 2	maxDepth	integer	Profundidad máxima de carpeta que recorrer, valor predeterminado 2
Número máximo de carpetas que se van a devolver. Valor predeterminado 20, máximo 200	maxReturn	integer	Número máximo de carpetas que se van a devolver. Valor predeterminado 20, máximo 200
Desplazamiento entero para la paginación. Valor predeterminado 0	offset	integer	Desplazamiento entero para la paginación. Valor predeterminado 0
Nombre del área de trabajo	workSpace	string	Nombre del área de trabajo

Devoluciones

Body: ResponseOfFolderResponse

Obtener cliente potencial por identificador

Id. de la operación:: getLeadByIdUsingGET

Recupera un único registro de cliente potencial a través de su identificador de Marketo. Permisos necesarios: Read-Only cliente potencial, Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de cliente potencial de Marketo	leadId	True	integer	Id. de cliente potencial de Marketo
Lista separada por comas de nombres de campo.	fields		array	Lista separada por comas de nombres de campo. Si se omite, se devolverán los siguientes campos predeterminados: email, updatedAt, createdAt, lastName, firstName e id.

Devoluciones

Body: ResponseOfLead

Obtener clientes potenciales por identificador de lista

Id. de la operación:: getLeadsByListIdUsingGET_1

Recupera los registros de persona que son miembros de la lista estática especificada. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de la lista estática para recuperar registros de	listId	True	integer	Id. de la lista estática para recuperar registros de
Lista separada por comas de campos de cliente potencial que se van a devolver para cada registro.	fields		array	Lista separada por comas de campos de cliente potencial que se van a devolver para cada registro. Si unset devolverá correo electrónico, updatedAt, createdAt, lastName, firstName e id.
Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.	batchSize		integer	Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.
Este punto de conexión devolverá un token. Consulta Paging Tokens (Tokens de paginación) para obtener más información.	nextPageToken		string	Este punto de conexión devolverá un token si el conjunto de resultados es mayor que el tamaño del lote y se puede pasar en una llamada posterior a través de este parámetro. Consulta Paging Tokens (Tokens de paginación) para obtener más información.

Devoluciones

Body: ResponseOfLead

Obtener clientes potenciales por identificador de lista

Id. de la operación:: getLeadsByListIdUsingGET

Recupera los registros de persona que son miembros de la lista estática especificada. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de la lista estática para recuperar registros de	listId	True	integer	Id. de la lista estática para recuperar registros de
Lista separada por comas de campos de cliente potencial que se van a devolver para cada registro.	fields		array	Lista separada por comas de campos de cliente potencial que se van a devolver para cada registro. Si unset devolverá correo electrónico, updatedAt, createdAt, lastName, firstName e id.
Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.	batchSize		integer	Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.
Este punto de conexión devolverá un token. Consulta Paging Tokens (Tokens de paginación) para obtener más información.	nextPageToken		string	Este punto de conexión devolverá un token si el conjunto de resultados es mayor que el tamaño del lote y se puede pasar en una llamada posterior a través de este parámetro. Consulta Paging Tokens (Tokens de paginación) para obtener más información.

Devoluciones

Body: ResponseOfLeadByListId

Obtener clientes potenciales por identificador de programa

Id. de la operación:: getLeadsByProgramIdUsingGET

Recupera una lista de clientes potenciales que son miembros del programa designado. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del programa del que se va a recuperar	programId	True	integer	Identificador del programa del que se va a recuperar
Lista separada por comas de campos que se van a devolver para cada registro	fields		array	Lista separada por comas de campos que se van a devolver para cada registro
Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.	batchSize		integer	Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.
Este punto de conexión devolverá un token. Consulta Paging Tokens (Tokens de paginación) para obtener más información.	nextPageToken		string	Este punto de conexión devolverá un token si el conjunto de resultados es mayor que el tamaño del lote y se puede pasar en una llamada posterior a través de este parámetro. Consulta Paging Tokens (Tokens de paginación) para obtener más información.

Devoluciones

Body: ResponseOfLead

Obtener clientes potenciales por tipo de filtro

Id. de la operación:: getLeadsByFilterUsingGET

Devuelve una lista de hasta 300 clientes potenciales en función de una lista de valores de un campo determinado. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Campo de cliente potencial en el que se va a filtrar.	filterType	True	string	Campo de cliente potencial en el que se va a filtrar. Todos los campos personalizados (solo tipos de cadena, correo electrónico o entero) y cualquiera de los siguientes campos son compatibles: cookies, correo electrónico, facebookId, id, leadPartitionId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId, twitterId. Se puede obtener una lista completa de campos a través del punto de conexión Describir lead2 .
Lista separada por comas de valores para filtrar en los campos especificados.	filterValues	True	array	Lista separada por comas de valores para filtrar en los campos especificados.
Lista separada por comas de campos de cliente potencial que se va a devolver para cada registro	fields		array	Lista separada por comas de campos de cliente potencial que se va a devolver para cada registro
Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.	batchSize		integer	Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.
Este punto de conexión devolverá un token. Consulta Paging Tokens (Tokens de paginación) para obtener más información.	nextPageToken		string	Este punto de conexión devolverá un token si el conjunto de resultados es mayor que el tamaño del lote y se puede pasar en una llamada posterior a través de este parámetro. Consulta Paging Tokens (Tokens de paginación) para obtener más información.

Devoluciones

Body: ResponseOfLead

Obtener contenido de la carpeta

Id. de la operación:: getFolderContentUsingGET

Devuelve registros para el contenido de una carpeta determinada. Permisos necesarios: recursos de Read-Only, recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la carpeta que se va a recuperar	id	True	integer	Identificador de la carpeta que se va a recuperar
Número máximo de canales que se van a devolver. Máximo 200, valor predeterminado 20	maxReturn		integer	Número máximo de canales que se van a devolver. Máximo 200, valor predeterminado 20
Desplazamiento entero para paginación	offset		integer	Desplazamiento entero para paginación
Tipo de carpeta. 'Carpeta' o 'Programa'. El valor predeterminado es 'Folder'	type	True	string	Tipo de carpeta. 'Carpeta' o 'Programa'. El valor predeterminado es 'Folder'

Devoluciones

Body: ResponseOfFolderContentResponse

Obtener el campo miembro del programa por nombre

Id. de la operación:: getProgramMemberFieldByNameUsingGET

Recupera metadatos para el campo miembro de un solo programa. Permisos necesarios: campo estándar de esquema Read-Write, campo personalizado de esquema Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre de API del campo miembro del programa	fieldApiName	True	string	Nombre de API del campo miembro del programa

Devoluciones

Body: ResponseOfLeadField

Obtener el estado del cliente potencial de importación

Id. de la operación:: getImportLeadStatusUsingGET

Devuelve el estado de un trabajo por lotes de importación. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de importación.	batchId	True	integer	Identificador del trabajo por lotes de importación.

Devoluciones

Body: ResponseOfImportLeadResponse

Obtener el estado del miembro del programa de importación

Id. de la operación:: getImportProgramMemberStatusUsingGET

Devuelve el estado de un trabajo por lotes de importación. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de importación.	batchId	True	integer	Identificador del trabajo por lotes de importación.

Devoluciones

Body: ResponseOfImportProgramMemberResponse

Obtener el estado del trabajo de cliente potencial de exportación

Id. de la operación:: getExportLeadsStatusUsingGET

Devuelve el estado de un trabajo de exportación. El estado del trabajo está disponible durante 30 días después de que se alcanzó el estado Completado o Erróneo. Permisos necesarios: Read-Only cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de exportación.	exportId	True	string	Identificador del trabajo por lotes de exportación.

Devoluciones

Body: ResponseOfExportResponse

Obtener el estado del trabajo del miembro del programa de exportación

Id. de la operación:: getExportProgramMembersStatusUsingGET

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de exportación.	exportId	True	string	Identificador del trabajo por lotes de exportación.

Devoluciones

Body: ResponseOfExportResponse

Obtener errores de miembro del programa de importación

Id. de la operación:: getImportProgramMemberFailuresUsingGET

Devuelve la lista de errores del trabajo por lotes de importación. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de importación.	batchId	True	integer	Identificador del trabajo por lotes de importación.

Devoluciones

response: object

Obtener lista estática por identificador

Id. de la operación:: getStaticListByIdUsingGET

Recupera un registro de lista estática por su identificador. Permisos necesarios: Read-Asset o Read-Write recurso

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la lista estática que se va a recuperar	id	True	integer	Identificador de la lista estática que se va a recuperar

Devoluciones

Body: ResponseOfStaticListResponse

Obtener lista estática por nombre

Id. de la operación:: getStaticListByNameUsingGET

Recupera un registro de lista estática por su nombre. Permisos necesarios: Read-Asset o recurso de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre de la lista estática que se va a recuperar	name	True	string	Nombre de la lista estática que se va a recuperar

Devoluciones

Body: ResponseOfStaticListResponse

Obtener lista inteligente por identificador

Id. de la operación:: getSmartListByIdUsingGET

Recupera un registro de lista inteligente por su identificador. Permisos necesarios: Read-Asset o Read-Write recurso

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la lista inteligente que se va a recuperar	id	True	integer	Identificador de la lista inteligente que se va a recuperar
Establezca true para rellenar las reglas de lista inteligente. Valor predeterminado false	includeRules		boolean	Establezca true para rellenar las reglas de lista inteligente. Valor predeterminado false

Devoluciones

Body: ResponseOfSmartListResponseWithRules

Obtener lista inteligente por identificador de programa

Id. de la operación:: getSmartListByProgramIdUsingGET

Recupera un registro de lista inteligente por su identificador de programa de correo electrónico. Permisos necesarios: Read-Asset o Read-Write recurso

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del programa de correo electrónico que contiene la lista inteligente que se va a recuperar	programId	True	integer	Identificador del programa de correo electrónico que contiene la lista inteligente que se va a recuperar
Establezca true para rellenar las reglas de lista inteligente. Valor predeterminado false	includeRules		boolean	Establezca true para rellenar las reglas de lista inteligente. Valor predeterminado false

Devoluciones

Body: ResponseOfSmartListResponseWithRules

Obtener lista inteligente por nombre

Id. de la operación:: getSmartListByNameUsingGET

Recupera un registro de lista inteligente por su nombre. Permisos necesarios: Read-Asset o recurso de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre de la lista inteligente que se va a recuperar	name	True	string	Nombre de la lista inteligente que se va a recuperar

Devoluciones

Body: ResponseOfSmartListResponse

Obtener lista por identificador

Id. de la operación:: getListByIdUsingGET

Devuelve un registro de lista por su identificador. Permisos necesarios: Read-Only cliente potencial, Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de la lista estática para recuperar registros de	listId	True	integer	Id. de la lista estática para recuperar registros de

Devoluciones

Body: ResponseOfStaticList

Obtener listas

Id. de la operación:: getListsUsingGET

Devuelve un conjunto de registros de lista estáticos basados en parámetros de filtro especificados. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial

Parámetros

Nombre	Clave	Tipo	Description
Lista separada por comas de identificadores de lista estáticos que se van a devolver	id	array	Lista separada por comas de identificadores de lista estáticos que se van a devolver
Lista separada por comas de nombres de lista estáticos que se van a devolver	name	array	Lista separada por comas de nombres de lista estáticos que se van a devolver
Lista separada por comas de nombres de programa.	programName	array	Lista separada por comas de nombres de programa. Si se establece, se devolverán todas las listas estáticas que son elementos secundarios de los programas especificados.
Lista separada por comas de nombres de área de trabajo.	workspaceName	array	Lista separada por comas de nombres de área de trabajo. Si se establece, se devolverán todas las listas estáticas que son elementos secundarios de las áreas de trabajo especificadas.
Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.	batchSize	integer	Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.
Este punto de conexión devolverá un token. Consulta Paging Tokens (Tokens de paginación) para obtener más información.	nextPageToken	string	Este punto de conexión devolverá un token si el conjunto de resultados es mayor que el tamaño del lote y se puede pasar en una llamada posterior a través de este parámetro. Consulta Paging Tokens (Tokens de paginación) para obtener más información.

Devoluciones

Body: ResponseOfStaticList

Obtener listas estáticas

Id. de la operación:: getStaticListsUsingGET

Recupera una lista de registros de lista estática. Permisos necesarios: Read-Asset o recurso de Read-Write

Parámetros

Nombre	Clave	Tipo	Description
Representación JSON de la carpeta primaria	folder	string	Representación JSON de la carpeta primaria, con miembros 'id' y 'type' que pueden ser 'Folder' o 'Program'
Desplazamiento entero para paginación	offset	integer	Desplazamiento entero para paginación
Número máximo de listas estáticas que se van a devolver. Máximo 200, valor predeterminado 20.	maxReturn	integer	Número máximo de listas estáticas que se van a devolver. Máximo 200, valor predeterminado 20.
Excluir listas estáticas antes de esta fecha. Consulte Descripción del tipo de campo Datetime.	earliestUpdatedAt	string	Excluir listas estáticas antes de esta fecha. Debe ser una cadena ISO-8601 válida. Consulte Descripción del tipo de campo Datetime .
Excluir listas estáticas después de esta fecha. Consulte Descripción del tipo de campo Datetime.	latestUpdatedAt	string	Excluir listas estáticas después de esta fecha. Debe ser una cadena ISO-8601 válida. Consulte Descripción del tipo de campo Datetime .

Devoluciones

Body: ResponseOfStaticListResponse

Obtener listas inteligentes

Id. de la operación:: getSmartListsUsingGET

Recupera una lista de registros de lista inteligente creados por el usuario. Permisos necesarios: Read-Asset o recurso de Read-Write

Parámetros

Nombre	Clave	Tipo	Description
Representación JSON de la carpeta primaria	folder	string	Representación JSON de la carpeta primaria, con miembros 'id' y 'type' que pueden ser 'Folder' o 'Program'
Desplazamiento entero para paginación	offset	integer	Desplazamiento entero para paginación
Número máximo de listas inteligentes que se van a devolver. Máximo 200, valor predeterminado 20.	maxReturn	integer	Número máximo de listas inteligentes que se van a devolver. Máximo 200, valor predeterminado 20.
Excluya listas inteligentes antes de esta fecha. Consulte Descripción del tipo de campo Datetime.	earliestUpdatedAt	string	Excluya listas inteligentes antes de esta fecha. Debe ser una cadena ISO-8601 válida. Consulte Descripción del tipo de campo Datetime .
Excluir listas inteligentes después de esta fecha. Consulte Descripción del tipo de campo Datetime.	latestUpdatedAt	string	Excluir listas inteligentes después de esta fecha. Debe ser una cadena ISO-8601 válida. Consulte Descripción del tipo de campo Datetime .

Devoluciones

Body: ResponseOfSmartListResponse

Obtener miembros del programa

Id. de la operación:: getProgramMembersUsingGET

Devuelve una lista de hasta 300 miembros del programa en una lista de valores de un campo determinado. Si especifica un filterType que es un campo personalizado, el tipo de datos del campo personalizado debe ser "string" o "integer". Si especifica un filterType distinto de "leadId", la solicitud puede procesar un máximo de 100 000 registros de miembros del programa. Permisos necesarios: cliente potencial de Read-Only, Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del programa de destino.	programId	True	integer	Identificador del programa de destino.
Campo miembro del programa que se va a filtrar.	filterType	True	string	Campo miembro del programa en el que se va a filtrar. Cualquier campo personalizado (solo tipos de cadena o entero), "updatedAt" o cualquier campo que se pueda buscar. Los campos que se pueden buscar se pueden obtener a través del punto de conexión Describir miembro del programa .
Lista separada por comas de valores para filtrar en los campos especificados.	filterValues	True	array	Lista separada por comas de valores para filtrar en los campos especificados.
Al usar filterType=updatedAt, el filtro de inicio del intervalo de fechas	startAt		string	Al usar filterType=updatedAt, el inicio del filtro de intervalo de fechas (formato ISO 8601)
Al usar filterType=updatedAt, el filtro de fin del intervalo de fechas	endAt		string	Al usar filterType=updatedAt, el filtro de fin del intervalo de fechas (formato ISO 8601)
Lista separada por comas de campos de cliente potencial que se van a devolver para cada registro.	fields		array	Lista separada por comas de campos de cliente potencial que se van a devolver para cada registro.
Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.	batchSize		integer	Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.
Si el conjunto de resultados es mayor que el tamaño del lote, devolverá un token.	nextPageToken		string	Este punto de conexión devolverá un token si el conjunto de resultados es mayor que el tamaño del lote y se puede pasar en una llamada posterior a través de este parámetro. Consulta Paging Tokens (Tokens de paginación) para obtener más información.

Devoluciones

Body: ResponseOfProgramMember

Obtener programa por identificador

Id. de la operación:: getProgramByIdUsingGET

Recupera el registro del programa para el identificador especificado. Permisos necesarios: recursos de Read-Only, recursos de Read-Write activos

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id. de programa	id	True	integer	id

Devoluciones

Body: ResponseOfProgramResponse

Obtener programa por nombre

Id. de la operación:: getProgramByNameUsingGET

Recupera el registro del programa para el nombre especificado. Permisos necesarios: recursos de Read-Only, recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre del programa	name	True	string	Nombre del programa
Establecer true para rellenar etiquetas de programa	includeTags		boolean	Establecer true para rellenar etiquetas de programa
Establecer true para rellenar los costos del programa	includeCosts		boolean	Establecer true para rellenar los costos del programa

Devoluciones

Body: ResponseOfProgramResponse

Obtener programas

Id. de la operación:: browseProgramsUsingGET

Recupera la lista de programas accesibles de la instancia de destino. Permisos necesarios: recursos de Read-Only, recursos de Read-Write

Parámetros

Nombre	Clave	Tipo	Description
Número máximo de canales que se van a devolver. Máximo 200, valor predeterminado 20	maxReturn	integer	Número máximo de canales que se van a devolver. Máximo 200, valor predeterminado 20
Desplazamiento entero para paginación	offset	integer	Desplazamiento entero para paginación
Filtro opcional. Requiere filterValues	filterType	string	Filtro opcional. Requiere filterValues
Excluya los programas anteriores a esta fecha. Consulte Descripción del tipo de campo Datetime.	earliestUpdatedAt	string	Excluya los programas anteriores a esta fecha. Debe ser una cadena ISO-8601 válida. Consulte Descripción del tipo de campo Datetime .
Excluir programas después de esta fecha. Consulte Descripción del tipo de campo Datetime.	latestUpdatedAt	string	Excluir programas después de esta fecha. Debe ser una cadena ISO-8601 válida. Consulte Descripción del tipo de campo Datetime .

Devoluciones

Body: ResponseOfBrowseAllPrograms

Obtener programas por etiqueta

Id. de la operación:: getProgramListByTagUsingGET

Recupera una lista de programas que coinciden con el tipo de etiqueta y los valores de etiqueta especificados. Permisos necesarios: recursos de Read-Only, recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Tipo de etiqueta de programa	tagType	True	string	Tipo de etiqueta de programa
Valor de la etiqueta	tagValue	True	string	Valor de la etiqueta
Número máximo de canales que se van a devolver. Máximo 200, valor predeterminado 20	maxReturn		integer	Número máximo de canales que se van a devolver. Máximo 200, valor predeterminado 20
Desplazamiento entero para paginación	offset		integer	Desplazamiento entero para paginación

Devoluciones

Body: ResponseOfProgramResponse

Obtener trabajos de cliente potencial de exportación

Id. de la operación:: getExportLeadsUsingGET

Devuelve una lista de trabajos de exportación creados en los últimos 7 días. Permisos necesarios: Read-Only cliente potencial

Parámetros

Nombre	Clave	Tipo	Description
Lista separada por comas de estados en los que filtrar.	status	array	Lista separada por comas de estados en los que filtrar.
Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.	batchSize	integer	Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.
Token de página siguiente	nextPageToken	string	Este punto de conexión devolverá un token si el conjunto de resultados es mayor que el tamaño del lote y se puede pasar en una llamada posterior a través de este parámetro. Consulta Paging Tokens (Tokens de paginación) para obtener más información.

Devoluciones

Body: ResponseOfExportResponseWithToken

Obtener trabajos de miembro del programa de exportación

Id. de la operación:: getExportProgramMembersUsingGET

Devuelve una lista de trabajos de exportación creados en los últimos 7 días. Permisos necesarios: Read-Only cliente potencial

Parámetros

Nombre	Clave	Tipo	Description
Lista separada por comas de estados en los que filtrar.	status	array	Lista separada por comas de estados en los que filtrar.
Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.	batchSize	integer	Tamaño del lote que se va a devolver. El valor máximo y predeterminado es 300.
Este punto de conexión lo devolverá si el conjunto de resultados es mayor que el tamaño del lote.	nextPageToken	string	Este punto de conexión devolverá un token si el conjunto de resultados es mayor que el tamaño del lote y se puede pasar en una llamada posterior a través de este parámetro. Consulta Paging Tokens (Tokens de paginación) para obtener más información.

Devoluciones

Body: ResponseOfExportResponseWithToken

Poner en cola el trabajo de cliente potencial de exportación

Id. de la operación:: enqueueExportLeadsUsingPOST

Poner en cola el trabajo de exportación. Esto colocará el trabajo de exportación en cola e iniciará el trabajo cuando los recursos informáticos estén disponibles. El trabajo de exportación debe estar en estado "Creado". Use el punto de conexión Obtener estado del trabajo de cliente potencial para recuperar el estado del trabajo de exportación. Permisos necesarios: Read-Only cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes de exportación.	exportId	True	string	Identificador del trabajo por lotes de exportación.

Devoluciones

Body: ResponseOfExportResponse

Poner en cola el trabajo de miembro del programa de exportación

Id. de la operación:: enqueueExportProgramMembersUsingPOST

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del trabajo por lotes.	exportId	True	string	Identificador del trabajo por lotes de exportación.

Devoluciones

Body: ResponseOfExportResponse

Programa no aprobado

Id. de la operación:: unapproveProgramUsingPOST

No aprueba el programa de destino. Solo es válido para programas de correo electrónico aprobados. Permisos necesarios: recursos de Read-Write

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id. de programa	id	True	integer	id

Devoluciones

Body: ResponseOfIdResponse

Programación de campaña

Id. de la operación:: scheduleCampaignUsingPOST

Programa de forma remota una campaña por lotes para que se ejecute en un momento dado. Mis tokens locales para el programa primario de la campaña se pueden invalidar para que la ejecución personalice el contenido. Al usar el parámetro "cloneToProgramName" descrito a continuación, este punto de conexión se limita a 20 llamadas al día. Permisos necesarios: Ejecutar campaña

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la campaña por lotes que se va a programar.	campaignId	True	integer	Identificador de la campaña por lotes que se va a programar.
cloneToProgramName	cloneToProgramName		string	Nombre del programa resultante. Cuando se establece, este atributo hará que la campaña, el programa primario y todos sus recursos se creen con el nuevo nombre resultante. El programa primario se clonará y se programará la campaña recién creada. El programa resultante se crea debajo del elemento primario. Es posible que los programas con fragmentos de código, notificaciones push, mensajes en la aplicación, listas estáticas, informes y recursos sociales no se clonen de esta manera.
runAt	runAt		date-time	Fecha y hora en la que se ejecutará la campaña. Si no se establece, la campaña se ejecutará cinco minutos después de que se realice la llamada.
nombre	name	True	string	Nombre del token. Debe tener el formato "{{my.name}}"
value	value	True	string	Valor del token

Devoluciones

Body: ResponseOfCampaign

Push Lead to Marketo

Id. de la operación:: pushToMarketoUsingPOST

Upserts un cliente potencial y genera una actividad Push Lead to Marketo. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id		integer	Identificador entero único de un registro de cliente potencial
código	code	True	string	Código entero del motivo
Mensaje	message	True	string	Mensaje que describe el motivo del estado de la operación
estado	status		string	Estado de la operación realizada en el registro
lookupField	lookupField		string
partitionName	partitionName		string
programName	programName		string
programStatus	programStatus		string
reason	reason		string
source	source		string

Devoluciones

Body: ResponseOfPushLeadToMarketo

Quitar de la lista

Id. de la operación:: removeLeadsFromListUsingDELETE

Quita un conjunto determinado de registros de persona de una lista estática de destino. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de la lista estática de la que se van a quitar clientes potenciales	listId	True	integer	Identificador de la lista estática de la que se van a quitar clientes potenciales
id	id	True	integer	Identificador entero único de un registro de cliente potencial
id	id	True	array	id

Devoluciones

Body: ResponseOfListOperationOutputData

Sincronizar datos de miembros del programa

Id. de la operación:: syncProgramMemberDataUsingPOST

Cambia los datos de los miembros del programa de una lista de clientes potenciales en un programa de destino. Solo los miembros existentes del programa pueden tener sus datos modificados con esta API. Permisos necesarios: Read-Write cliente potencial

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del programa de destino.	programId	True	integer	Identificador del programa de destino.
leadId	leadId	True	integer	Identificador entero único de un registro de cliente potencial
{fieldApiName}	{fieldApiName}	True	string	Nombre de LA API del campo que se va a actualizar. Debe actualizarse como se describe en Descripción del punto de conexión de miembro del programa .
{fieldApiName2}	{fieldApiName2}		string	Nombre de API de otro campo que se va a actualizar (etc.). Debe actualizarse como se describe en Descripción del punto de conexión de miembro del programa .

Devoluciones

Body: ResponseOfProgramMemberData

Definiciones

ResponseOfIdentity

Nombre	Ruta de acceso	Tipo	Description
access_token	access_token	string	Token que se pasa con llamadas posteriores para autenticarse con la instancia de destino
scope	scope	string	Usuario propietario de solo API del servicio personalizado que se usó para autenticarse
expires_in	expires_in	integer	Duración restante del token actual en segundos
token_type	token_type	string	Método de autenticación de OAuth

ResponseOfStaticList

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of StaticList	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

Plomo

Registro de cliente potencial. Siempre contiene el identificador, pero puede tener cualquier número de otros campos, dependiendo de los campos disponibles en la instancia de destino.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador entero único de un registro de cliente potencial
membresía	membership	ProgramMembership
reason	reason	Reason
estado	status	string	Estado de la operación realizada en el registro

LeadField

Registro de campo de cliente potencial

Nombre	Ruta de acceso	Tipo	Description
Nombre para mostrar	displayName	string	Nombre para mostrar de la interfaz de usuario del campo
nombre	name	string	Nombre de LA API del campo
descripción	description	string	Descripción del campo
Tipo de dato	dataType	string	Tipo de datos del campo
length	length	integer	Longitud máxima del campo. Solo se aplica al área de texto, cadena y texto.
isHidden	isHidden	boolean	Si se establece en true, el campo está oculto.
isHtmlEncodingInEmail	isHtmlEncodingInEmail	boolean	Si se establece en true, el campo se codifica como HTML en el correo electrónico.
isSensitive	isSensitive	boolean	Si se establece en true, el campo se marca como confidencial.
isCustom	isCustom	boolean	Si se establece en true, el campo es personalizado.
isApiCreated	isApiCreated	boolean	Si se establece en true, el campo se creó mediante la API REST.

LeadFieldStatus

Estado de actualización del campo de cliente potencial

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Nombre de LA API del campo
estado	status	string	Estado de la operación realizada en el registro

ListOperationOutputData

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador entero único de un registro de cliente potencial
Razones	reasons	array of Reason	Lista de motivos por los que una operación no se realizó correctamente. Las razones solo están presentes en las respuestas de API y no deben enviarse
estado	status	string	Estado de la operación realizada en el registro

LeadAttribute

Nombre	Ruta de acceso	Tipo	Description
Tipo de dato	dataType	string	Tipo de datos del campo
Nombre para mostrar	displayName	string	Nombre para mostrar de la interfaz de usuario del campo
id	id	integer	Identificador entero único del campo
length	length	integer	Longitud máxima del campo. Solo se aplica al área de texto, cadena y texto.
reposo	rest	LeadMapAttribute
jabón	soap	LeadMapAttribute

LeadAttribute2

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	"Cliente potencial de API"
searchableFields	searchableFields	array of LeadAttribute2SearchableFields	Lista de campos que se pueden buscar
fields	fields	array of LeadAttribute2Fields	Descripción de los campos que se pueden buscar

LeadAttribute2SearchableFields

Lista de campos que se pueden buscar

Nombre	Ruta de acceso	Tipo	Description
Productos		string	Campo que se puede buscar

LeadAttribute2Fields

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Nombre de la API REST del campo
Nombre para mostrar	displayName	string	Nombre para mostrar del campo (nombre descriptivo)
Tipo de dato	dataType	string	Tipo de datos de campo
length	length	integer	Longitud del campo
updateable	updateable	boolean	¿Se puede actualizar el campo?
crmManaged	crmManaged	boolean	Es el campo administrado por CRM

LeadAttribute2Fields2

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Nombre de la API REST del campo
Nombre para mostrar	displayName	string	Nombre para mostrar del campo (nombre descriptivo)
Tipo de dato	dataType	string	Tipo de datos de campo
length	length	integer	Longitud del campo
updateable	updateable	boolean	¿Se puede actualizar el campo?
crmManaged	crmManaged	boolean	Es el campo administrado por CRM

ProgramMemberAttribute

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	"Miembro del programa de API"
fields	fields	array of LeadAttribute2Fields	Descripción de los campos que se pueden buscar

ProgramMemberAttribute2

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	"Miembro del programa de API"
descripción	description	string	"Mapa de miembros del programa de API"
createdAt	createdAt	string	Fecha y hora cuando se creó
updatedAt	updatedAt	string	Fecha y hora actualizada
dedupeFields	dedupeFields	array of string	Lista de campos de desduplicación
searchableFields	searchableFields	array of LeadAttribute2SearchableFields	Lista de campos que se pueden buscar
fields	fields	array of LeadAttribute2Fields2	Descripción de los campos que se pueden buscar

ResponseOfImportLeadResponse

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of ImportLeadResponse	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ImportProgramMemberResponse

Respuesta que contiene información de estado de importación

Nombre	Ruta de acceso	Tipo	Description
batchId	batchId	integer	Identificador entero único del trabajo de importación
importId	importId	string	Identificador entero único del trabajo de importación
estado	status	string	Estado del trabajo de importación

ResponseOfImportProgramMemberResponse

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of ImportProgramMemberResponse	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfCampaign

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of Campaign	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfListOperationOutputData

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of ListOperationOutputData	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

Campaña

Registro de una campaña inteligente de Marketo

Nombre	Ruta de acceso	Tipo	Description
activo	active	boolean	Si la campaña está activa. Solo se aplica a las campañas de desencadenador
createdAt	createdAt	string	Fecha y hora en que se creó la campaña
descripción	description	string	Descripción de la campaña inteligente
id	id	integer	Identificador entero único de la campaña inteligente
nombre	name	string	Nombre de la campaña inteligente
programId	programId	integer	Identificador del programa primario si procede
programName	programName	string	Nombre del programa primario si procede
type	type	string	Tipo de la campaña inteligente
updatedAt	updatedAt	string	Fecha y hora en que la campaña se actualizó más recientemente
workspaceName	workspaceName	string	Nombre del área de trabajo primaria si procede

ResponseOfLead

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of Lead	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfLeadByListId

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of Lead	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfLeadField

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of LeadField	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfUpdateLeadField

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of LeadFieldStatus	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfPushLeadToMarketo

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of Lead	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfLeadAttribute

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of LeadAttribute	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfLeadAttribute2

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of LeadAttribute2	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfProgramMemberAttributes

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of ProgramMemberAttribute	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfProgramMemberAttributes2

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of ProgramMemberAttribute2	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

Advertencia

Nombre	Ruta de acceso	Tipo	Description
código	code	integer	Código entero de la advertencia
Mensaje	message	string	Mensaje que describe la advertencia

ResponseOfExportResponse

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of ExportResponse	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfExportResponseWithToken

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of ExportResponse	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfProgramMember

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of ProgramMember	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ProgramMember

Registro de miembro del programa. Siempre contiene el identificador de cliente potencial, pero puede tener cualquier número de otros campos, dependiendo de los campos disponibles en la instancia de destino.

Nombre	Ruta de acceso	Tipo	Description
Seq	seq	integer	Entero que indica la secuencia del registro en respuesta. Este valor se correlaciona con el orden de los registros incluidos en la entrada de solicitud. Seq solo debe formar parte de las respuestas y no debe enviarse.
leadId	leadId	integer	Identificador entero único de un registro de cliente potencial
reachedSuccess	reachedSuccess	boolean	Boolean que indica si el miembro del programa ha alcanzado criterios de éxito para el programa
programId	programId	integer	Identificador entero único de un programa
acquiredBy	acquiredBy	boolean	Boolean que indica si el miembro del programa fue adquirido por el programa
membershipDate	membershipDate	string	Fecha en que el cliente potencial se convirtió en miembro del programa por primera vez

ResponseOfProgramMemberStatus

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of ProgramMemberStatusResponse	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfProgramMemberData

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of ProgramMemberStatusResponse	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ResponseOfProgramMemberDelete

Nombre	Ruta de acceso	Tipo	Description
Errores	errors	array of Error	Matriz de errores que se produjeron si la solicitud no se realizó correctamente
moreResult	moreResult	boolean	Boolean que indica si hay más resultados en páginas posteriores
nextPageToken	nextPageToken	string	Token de paginación proporcionado si el conjunto de resultados superó el tamaño de lote permitido
requestId	requestId	string	Identificador de la solicitud realizada
resultado	result	array of ProgramMemberDeleteResponse	Matriz de resultados para registros individuales en la operación, puede estar vacía
correcto	success	boolean	Si la solicitud se realizó correctamente
Advertencias	warnings	array of Warning	Matriz de advertencias dadas para la operación

ImportLeadResponse

Respuesta que contiene información de estado de importación

Nombre	Ruta de acceso	Tipo	Description
batchId	batchId	integer	Identificador entero único del lote de importación
importId	importId	string
Mensaje	message	string
numOfLeadsProcessed	numOfLeadsProcessed	integer	Número de filas procesadas hasta ahora
numOfRowsFailed	numOfRowsFailed	integer	Número de filas con errores hasta ahora
numOfRowsWithWarning	numOfRowsWithWarning	integer	Número de filas con una advertencia hasta ahora
estado	status	string	Estado del lote

ProgramMembership

Nombre	Ruta de acceso	Tipo	Description
acquiredBy	acquiredBy	boolean	Si el programa primario adquirió el cliente potencial
isExhausted	isExhausted	boolean	Si el cliente potencial se agota actualmente en el flujo, si procede
membershipDate	membershipDate	string	Fecha en que el cliente potencial se convirtió en miembro del programa por primera vez
nurtureCadence	nurtureCadence	string	Cadencia de la secuencia primaria si procede
progressionStatus	progressionStatus	string	Estado del programa del cliente potencial en el programa primario
reachedSuccess	reachedSuccess	boolean	Si el cliente potencial está en un estado correcto en el programa primario
flujo	stream	string	Stream that the lead is a member of, if the parent program is an engagement program

ExportResponse

Respuesta que contiene la información de estado del trabajo de exportación

Nombre	Ruta de acceso	Tipo	Description
createdAt	createdAt	date-time	Fecha en la que se creó la solicitud de exportación
errorMsg	errorMsg	string	Mensaje de error en caso de estado "Error"
exportId	exportId	string	Identificador único del trabajo de exportación
tamaño de archivo	fileSize	integer	Tamaño del archivo exportado en bytes. Esto solo tendrá un valor cuando el estado sea "Completado", de lo contrario, null.
fileChecksum	fileChecksum	string	Hash SHA-256 del archivo exportado. Esto solo tendrá un valor cuando el estado sea "Completado", de lo contrario, null.
finishedAt	finishedAt	date-time	Hora de finalización del trabajo de exportación. Este valor solo tendrá el valor cuando el estado sea "Completado" o "Failed", de lo contrario, null.
format	format	string	Formato del archivo tal y como se indica en la solicitud ("CSV", "TSV", "SSV")
numberOfRecords	numberOfRecords	integer	Número de registros del archivo de exportación. Este valor solo tendrá el valor cuando el estado sea "Completed", de lo contrario, null
queuedAt	queuedAt	date-time	Tiempo de cola del trabajo de exportación. Esto tendrá un valor cuando se alcance el estado "Queued", antes de que se alcance ese valor NULL.
startedAt	startedAt	date-time	Hora de inicio del trabajo de exportación. Esto tendrá un valor cuando se alcance el estado "Processing", antes de que se alcance ese valor NULL.
estado	status	string	Estado del trabajo de exportación ("Created","Queued","Processing","Canceled","Completed","Failed")

Motivo

Nombre	Ruta de acceso	Tipo	Description
código	code	string	Código entero del motivo
Mensaje	message	string	Mensaje que describe el motivo del estado de la operación

LeadMapAttribute

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Nombre del atributo
Solo lectura	readOnly	boolean	Si el atributo es de solo lectura

Error

Nombre	Ruta de acceso	Tipo	Description
código	code	string	Código de error del error. Consulte la lista completa de códigos de error aquí.
Mensaje	message	string	Mensaje que describe la causa del error

ProgramMemberStatusResponse

Nombre	Ruta de acceso	Tipo	Description
estado	status	string	Estado de la operación realizada en el registro
Razones	reasons	array of Reason	Lista de motivos por los que una operación no se realizó correctamente. Las razones solo están presentes en las respuestas de API y no deben enviarse
leadId	leadId	integer	Identificador del cliente potencial asociado al miembro del programa
Seq	seq	integer	Entero que indica la secuencia del registro en respuesta. Este valor se correlaciona con el orden de los registros incluidos en la entrada de solicitud. Seq solo debe formar parte de las respuestas y no debe enviarse.

ProgramMemberDeleteResponse

Nombre	Ruta de acceso	Tipo	Description
estado	status	string	Estado de la operación realizada en el registro
Razones	reasons	array of Reason	Lista de motivos por los que una operación no se realizó correctamente. Las razones solo están presentes en las respuestas de API y no deben enviarse
leadId	leadId	integer	Identificador del cliente potencial asociado al miembro del programa
Seq	seq	integer	Entero que indica la secuencia del registro en respuesta. Este valor se correlaciona con el orden de los registros incluidos en la entrada de solicitud. Seq solo debe formar parte de las respuestas y no debe enviarse.

StaticList

Nombre	Ruta de acceso	Tipo	Description
createdAt	createdAt	string	Fecha y hora en que se creó la lista
descripción	description	string	Descripción de la lista estática
id	id	integer	Identificador entero único de la lista estática
nombre	name	string	Nombre de la lista estática
programName	programName	string	Nombre del programa
updatedAt	updatedAt	string	Fecha y hora en que la lista se actualizó más recientemente
workspaceName	workspaceName	string	Nombre del área de trabajo primaria, si procede

BrowseAllPrograms

Nombre	Ruta de acceso	Tipo	Description
Canal	channel	string	Canal del programa
createdAt	createdAt	date-time	Fecha y hora en que se creó el recurso
descripción	description	string	Descripción del recurso
folder	folder	Folder	Representación JSON de una carpeta
id	id	integer	Identificador del recurso
nombre	name	string	Nombre del recurso
sfdcId	sfdcId	string	Identificador de SFDC del programa si está vinculado a una campaña de SFDC
sfdcName	sfdcName	string	Nombre de la campaña DE SFDC vinculada si procede
estado	status	string	Estado del programa. Solo es válido para los tipos de programa email y engagement.
type	type	string	Tipo del programa
updatedAt	updatedAt	date-time	Fecha y hora en que el recurso se actualizó más recientemente
URL	url	string	Dirección URL del recurso en la interfaz de usuario de Marketo
workspace	workspace	string	Nombre del área de trabajo

FolderContentResponse

Nombre	Ruta de acceso	Tipo	Description
id	id	integer
type	type	string

FileFolder

Nombre	Ruta de acceso	Tipo
id	id	integer
nombre	name	string
type	type	string

ResponseOfProgramResponse

Nombre	Ruta de acceso	Tipo
Errores	errors	array of Error
requestId	requestId	string
resultado	result	array of ProgramResponse
correcto	success	boolean
Advertencias	warnings	array of string

ResponseOfSmartListResponse

Nombre	Ruta de acceso	Tipo
Errores	errors	array of Error
requestId	requestId	string
resultado	result	array of SmartListResponse
correcto	success	boolean
Advertencias	warnings	array of string

ResponseOfSmartListResponseWithRules

Nombre	Ruta de acceso	Tipo
Errores	errors	array of Error
requestId	requestId	string
resultado	result	array of SmartListResponseWithRules
correcto	success	boolean
Advertencias	warnings	array of string

SmartListResponse

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador de la lista inteligente
nombre	name	string	Nombre de la lista inteligente
descripción	description	string	Descripción de la lista inteligente
createdAt	createdAt	date-time	Fecha y hora en que se creó la lista inteligente
updatedAt	updatedAt	date-time	Fecha y hora en que la lista inteligente se actualizó más recientemente
URL	url	string	Dirección URL de la lista inteligente en la interfaz de usuario de Marketo
folder	folder	Folder	Representación JSON de una carpeta
workspace	workspace	string	Nombre del área de trabajo

SmartListResponseWithRules

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador de la lista inteligente
nombre	name	string	Nombre de la lista inteligente
descripción	description	string	Descripción de la lista inteligente
createdAt	createdAt	date-time	Fecha y hora en que se creó la lista inteligente
updatedAt	updatedAt	date-time	Fecha y hora en que la lista inteligente se actualizó más recientemente
URL	url	string	Dirección URL de la lista inteligente en la interfaz de usuario de Marketo
folder	folder	Folder	Representación JSON de una carpeta
workspace	workspace	string	Nombre del área de trabajo
reglas	rules	SmartListRules	Representación JSON de reglas de lista inteligente

ResponseOfStaticListResponse

Nombre	Ruta de acceso	Tipo
Errores	errors	array of Error
requestId	requestId	string
resultado	result	array of StaticListResponse
correcto	success	boolean
Advertencias	warnings	array of string

StaticListResponse

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador de la lista estática
nombre	name	string	Nombre de la lista estática
descripción	description	string	Descripción de la lista estática
createdAt	createdAt	date-time	Fecha y hora en que se creó la lista estática
updatedAt	updatedAt	date-time	Fecha y hora en que la lista estática se actualizó más recientemente
URL	url	string	Dirección URL de la lista estática en la interfaz de usuario de Marketo
folder	folder	Folder	Representación JSON de una carpeta
workspace	workspace	string	Nombre del área de trabajo
computedUrl	computedUrl	string

ProgramResponse

Nombre	Ruta de acceso	Tipo	Description
Canal	channel	string	Canal del programa
costs	costs	array of Costs	Listas de costos de período asociados
createdAt	createdAt	date-time	Fecha y hora en que se creó el recurso
descripción	description	string	Descripción del recurso
fecha de finalización	endDate	date-time	Fecha de finalización del programa. Aplicable a los programas de tipo evento, correo electrónico y seminario web
folder	folder	ProgramFolder
id	id	integer	Identificador del recurso
nombre	name	string	Nombre del recurso
sfdcId	sfdcId	string	Identificador de SFDC del programa si está vinculado a una campaña de SFDC
sfdcName	sfdcName	string	Nombre de la campaña DE SFDC vinculada si procede
startDate	startDate	date-time	Fecha de inicio del programa. Aplicable a los programas de eventos, correo electrónico y tipo de seminario web
estado	status	string	Estado del programa. Solo es válido para los tipos de programa email y engagement.
tags	tags	array of Tags	Lista de etiquetas de programa asociadas
type	type	string	Tipo del programa
updatedAt	updatedAt	date-time	Fecha y hora en que el recurso se actualizó más recientemente
URL	url	string	Dirección URL del recurso en la interfaz de usuario de Marketo
workspace	workspace	string	Nombre del área de trabajo
marketingProgramProgressionId	marketingProgramProgressionId	integer
headStart	headStart	boolean	Si la función "Head Start" está habilitada para el programa

FileResponse

Nombre	Ruta de acceso	Tipo	Description
createdAt	createdAt	date-time	Fecha y hora en que se creó el archivo
descripción	description	string	Descripción del archivo
folder	folder	FileFolder
id	id	integer	Identificador del archivo
tipo MIME	mimeType	string	Tipo MIME del archivo
nombre	name	string	Nombre del archivo
size	size	integer	Tamaño del archivo en bytes
updatedAt	updatedAt	date-time	Fecha y hora en que el archivo se actualizó más recientemente
URL	url	string	Dirección URL accesible públicamente del archivo

ResponseOfFileResponse

Nombre	Ruta de acceso	Tipo
Errores	errors	array of Error
requestId	requestId	string
resultado	result	array of FileResponse
correcto	success	boolean
Advertencias	warnings	array of string

FolderResponse

Nombre	Ruta de acceso	Tipo	Description
accessZoneId	accessZoneId	integer
createdAt	createdAt	date-time	Fecha y hora en que se creó la carpeta
descripción	description	string	Descripción de la carpeta
folderId	folderId	Folder	Representación JSON de una carpeta
folderType	folderType	string	Tipo de carpeta
id	id	integer	Identificador de la carpeta
isArchive	isArchive	boolean	Estado de archivo de la carpeta
isSystem	isSystem	boolean	Si la carpeta está administrada por el sistema
nombre	name	string	Nombre de la carpeta. No aplicable a los programas
parent	parent	Folder	Representación JSON de una carpeta
camino	path	string	Ruta de acceso de la carpeta
updatedAt	updatedAt	date-time	Fecha y hora en que la carpeta se actualizó por última vez
URL	url	string	Dirección URL de la carpeta
workspace	workspace	string	Nombre del área de trabajo

ResponseOfIdResponse

Nombre	Ruta de acceso	Tipo
Errores	errors	array of Error
requestId	requestId	string
resultado	result	array of IdResponse
correcto	success	boolean
Advertencias	warnings	array of string

Etiquetas

Nombre	Ruta de acceso	Tipo	Description
tagType	tagType	string	Nombre de la etiqueta
tagValue	tagValue	string	Valor de la etiqueta

ResponseOfBrowseAllPrograms

Nombre	Ruta de acceso	Tipo
Errores	errors	array of Error
requestId	requestId	string
resultado	result	array of BrowseAllPrograms
correcto	success	boolean
Advertencias	warnings	array of string

ResponseOfFolderResponse

Nombre	Ruta de acceso	Tipo
Errores	errors	array of Error
requestId	requestId	string
resultado	result	array of FolderResponse
correcto	success	boolean
Advertencias	warnings	array of string

ResponseOfFolderContentResponse

Nombre	Ruta de acceso	Tipo
Errores	errors	array of Error
requestId	requestId	string
resultado	result	array of FolderContentResponse
correcto	success	boolean
Advertencias	warnings	array of string

IdResponse

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador del recurso

Costos

Nombre	Ruta de acceso	Tipo	Description
costo	cost	integer	Importe del costo
nota	note	string	Notas sobre el costo
startDate	startDate	date-time	Fecha de inicio del costo del período

ProgramFolder

Nombre	Ruta de acceso	Tipo	Description
type	type	string	Tipo de carpeta de programa
value	value	integer	Identificador de la carpeta del programa
folderName	folderName	string	Nombre de la carpeta del programa

Carpeta

Representación JSON de una carpeta

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador de la carpeta
type	type	string	Tipo de carpeta

SmartListRules

Representación JSON de reglas de lista inteligente

Nombre	Ruta de acceso	Tipo	Description
filterMatchType	filterMatchType	string	Tipo de coincidencia de filtro de lista inteligente (lógica de regla)
Desencadenadores	triggers	array of string	Lista de desencadenadores de lista inteligente
filters	filters	array of SmartListFilters	Lista de filtros de lista inteligente

SmartListFilters

Representación JSON de filtros de lista inteligente

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador del filtro
nombre	name	string	Nombre del filtro
ruleTypeId	ruleTypeId	integer	Identificador del tipo de regla
ruleType	ruleType	string	Nombre del tipo de regla
operator	operator	string	Nombre del operador
condiciones	conditions	array of SmartListConditions	Lista de condiciones de lista inteligente

SmartListConditions

Representación JSON de las condiciones de lista inteligente

Nombre	Ruta de acceso	Tipo	Description
activityAttributeId	activityAttributeId	integer	Identificador del atributo de actividad
activityAttributeName	activityAttributeName	string	Nombre del atributo de actividad
operator	operator	string	Valor del operador
values	values	array of string	Lista de valores
isPrimario	isPrimary	boolean	Si la condición es principal o no (primera condición de la lista inteligente)

objeto

Este es el tipo 'object'.

Compartir a través de

Marketo MA (versión preliminar)

Creación de una conexión

Predeterminado

Limitaciones

Acciones

Actualizar campo de cliente potencial

Parámetros

Devoluciones

Actualizar contenido de archivo

Parámetros

Devoluciones

Actualizar etiqueta de programa

Parámetros

Devoluciones

Actualizar metadatos de carpeta

Parámetros

Devoluciones

Actualizar metadatos de lista estática

Parámetros

Devoluciones

Actualizar metadatos del programa

Parámetros

Devoluciones

Agregar a la lista

Parámetros

Devoluciones

Aprobar programa

Parámetros

Devoluciones

Campaña de solicitud

Parámetros

Devoluciones

Cancelar el trabajo de cliente potencial de exportación

Parámetros

Devoluciones

Cancelar trabajo de miembro del programa de exportación

Parámetros

Devoluciones

Clientes potenciales de sincronización

Parámetros

Devoluciones

Clonar lista inteligente

Parámetros

Devoluciones

Clonar programa

Parámetros

Devoluciones

Creación de un trabajo de cliente potencial de exportación

Parámetros

Devoluciones

Crear archivo

Parámetros

Devoluciones

Crear carpeta

Parámetros

Devoluciones

Crear lista estática

Parámetros

Devoluciones

Crear programa

Parámetros

Devoluciones

Crear trabajo de miembro del programa de exportación

Parámetros

Devoluciones

Describir lead2

Devoluciones

Describir miembro del programa

Devoluciones

Describir miembro del programa

Devoluciones

Descripción del cliente potencial

Devoluciones

Eliminar carpeta

Parámetros

Devoluciones

Eliminar clientes potenciales

Parámetros

Devoluciones