Listar proyectos
Los proyectos agrupan páginas, sitios, embudos y productos.
Alcance requerido: projects:read.
query Parameters
limitCantidad máxima de registros. El valor predeterminado es 50 y el máximo es 100.
pageÍndice de página que empieza en cero. La API devuelve limit registros a partir de page × limit.
Listar proyectos › Responses
Registros coincidentes. El cuerpo es un arreglo JSON.
idId del proyecto.
nameNombre.
descriptionDescripción.
contextBrief de marca. Presente al crear y actualizar.
activefalse cuando el proyecto está inactivo.
created_atMarca de tiempo ISO-8601.
updated_atMarca de tiempo ISO-8601.
Crear un proyecto
name es obligatorio. description debe tener al menos 50 caracteres. context debe tener al menos 200 caracteres. Se requiere un plan de pago.
Alcance requerido: projects:write.
Crear un proyecto › Request Body
nameNombre del proyecto.
descriptionAl menos 50 caracteres.
contextAl menos 200 caracteres sobre la marca y la oferta.
Crear un proyecto › Responses
El proyecto creado.
idId del proyecto.
nameNombre.
descriptionDescripción.
contextBrief de marca. Presente al crear y actualizar.
activefalse cuando el proyecto está inactivo.
created_atMarca de tiempo ISO-8601.
updated_atMarca de tiempo ISO-8601.
Buscar proyectos
Pasa project_id para uno, o query para nombre y descripción. Siempre devuelve un arreglo.
Alcance requerido: projects:read.
query Parameters
limitCantidad máxima de registros. El valor predeterminado es 50 y el máximo es 100.
queryTexto sin distinción de mayúsculas que se compara con el nombre y los campos relacionados.
project_idId exacto del proyecto.
Buscar proyectos › Responses
Registros coincidentes. El cuerpo es un arreglo JSON.
idId del proyecto.
nameNombre.
descriptionDescripción.
contextBrief de marca. Presente al crear y actualizar.
activefalse cuando el proyecto está inactivo.
created_atMarca de tiempo ISO-8601.
updated_atMarca de tiempo ISO-8601.
Obtener un proyecto
Alcance requerido: projects:read.
path Parameters
projectIdId del proyecto.
Obtener un proyecto › Responses
El proyecto.
idId del proyecto.
nameNombre.
descriptionDescripción.
contextBrief de marca. Presente al crear y actualizar.
activefalse cuando el proyecto está inactivo.
created_atMarca de tiempo ISO-8601.
updated_atMarca de tiempo ISO-8601.
Eliminar un proyecto sin uso
Elimina el proyecto solo si ninguna página, producto, sitio o embudo lo referencia. Si no, responde 409 project_in_use.
Alcance requerido: projects:write.
path Parameters
projectIdId del proyecto.
Eliminar un proyecto sin uso › Responses
El registro fue eliminado.
successtrue cuando la eliminación tuvo éxito.
idId del registro eliminado.
deletedtrue cuando el registro se eliminó.
Actualizar un proyecto
Envía solo los campos que quieres cambiar.
Alcance requerido: projects:write.
path Parameters
projectIdId del proyecto.
Actualizar un proyecto › Request Body
nameNuevo nombre.
descriptionNueva descripción.
contextNuevo brief.
Actualizar un proyecto › Responses
El proyecto actualizado.
idId del proyecto.
nameNombre.
descriptionDescripción.
contextBrief de marca. Presente al crear y actualizar.
activefalse cuando el proyecto está inactivo.
created_atMarca de tiempo ISO-8601.
updated_atMarca de tiempo ISO-8601.