> For the complete documentation index, see [llms.txt](https://developers.myscreators.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.myscreators.com/referencia-de-la-api/leads.md).

# Leads

Prospectos: crear, consultar, actualizar y buscar.

Operaciones para gestionar prospectos (leads).

## POST /leads

> Crear lead

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Leads","description":"Gestión de prospectos (leads): crear, consultar, actualizar y buscar."}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken","description":"Token de instalación de M&S. Envíalo en el encabezado `authtoken` de cada solicitud."}},"schemas":{"LeadCreate":{"type":"object","description":"Datos para crear un lead.","required":["company_name","owner_id","lead_status_id","lead_source_id"],"properties":{"company_name":{"type":"string"},"owner_id":{"type":"string","description":"ID del responsable."},"lead_status_id":{"type":"string","description":"ID del estado del lead."},"lead_source_id":{"type":"string","description":"ID de la fuente del lead."},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"vat_number":{"type":"string","description":"NIT / identificación fiscal."}}},"ApiMessage":{"type":"object","description":"Respuesta genérica de estado para operaciones de escritura y borrado.","properties":{"status":{"type":"boolean","description":"`true` si la operación fue exitosa."},"message":{"type":"string","description":"Mensaje legible del resultado."}}}},"responses":{"Unauthorized":{"description":"Token ausente o inválido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}},"paths":{"/leads":{"post":{"tags":["Leads"],"operationId":"createLead","summary":"Crear lead","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/LeadCreate"}}}},"responses":{"200":{"description":"Lead creado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```

## GET /leads/{id}

> Obtener lead por ID

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Leads","description":"Gestión de prospectos (leads): crear, consultar, actualizar y buscar."}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken","description":"Token de instalación de M&S. Envíalo en el encabezado `authtoken` de cada solicitud."}},"schemas":{"Lead":{"type":"object","description":"Prospecto (lead).","properties":{"id":{"type":"integer"},"company_name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"created_date":{"type":"string","format":"date"},"website":{"type":"string"},"phone":{"type":"string"},"lead_status_title":{"type":"string"},"owner_name":{"type":"string"}}},"ApiMessage":{"type":"object","description":"Respuesta genérica de estado para operaciones de escritura y borrado.","properties":{"status":{"type":"boolean","description":"`true` si la operación fue exitosa."},"message":{"type":"string","description":"Mensaje legible del resultado."}}}},"responses":{"Unauthorized":{"description":"Token ausente o inválido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}},"NotFound":{"description":"Recurso no encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}},"paths":{"/leads/{id}":{"get":{"tags":["Leads"],"operationId":"getLead","summary":"Obtener lead por ID","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"},"description":"Identificador del recurso."}],"responses":{"200":{"description":"Lead.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lead"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```

## PUT /leads/{id}

> Actualizar lead

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Leads","description":"Gestión de prospectos (leads): crear, consultar, actualizar y buscar."}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken","description":"Token de instalación de M&S. Envíalo en el encabezado `authtoken` de cada solicitud."}},"schemas":{"LeadUpdate":{"description":"Datos para actualizar un lead (mismos campos que la creación).","allOf":[{"$ref":"#/components/schemas/LeadCreate"}]},"LeadCreate":{"type":"object","description":"Datos para crear un lead.","required":["company_name","owner_id","lead_status_id","lead_source_id"],"properties":{"company_name":{"type":"string"},"owner_id":{"type":"string","description":"ID del responsable."},"lead_status_id":{"type":"string","description":"ID del estado del lead."},"lead_source_id":{"type":"string","description":"ID de la fuente del lead."},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"vat_number":{"type":"string","description":"NIT / identificación fiscal."}}},"ApiMessage":{"type":"object","description":"Respuesta genérica de estado para operaciones de escritura y borrado.","properties":{"status":{"type":"boolean","description":"`true` si la operación fue exitosa."},"message":{"type":"string","description":"Mensaje legible del resultado."}}}},"responses":{"Unauthorized":{"description":"Token ausente o inválido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}},"NotFound":{"description":"Recurso no encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}},"paths":{"/leads/{id}":{"put":{"tags":["Leads"],"operationId":"updateLead","summary":"Actualizar lead","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"},"description":"Identificador del recurso."}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/LeadUpdate"}}}},"responses":{"200":{"description":"Lead actualizado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```

## Buscar leads

> Si tu instalación no ofrece esta ruta, usa \`/projects/search/{keysearch}\`.

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Leads","description":"Gestión de prospectos (leads): crear, consultar, actualizar y buscar."}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken","description":"Token de instalación de M&S. Envíalo en el encabezado `authtoken` de cada solicitud."}},"schemas":{"LeadSearchItem":{"type":"object","description":"Coincidencia de lead en una búsqueda.","properties":{"id":{"type":"integer"},"company_name":{"type":"string"},"lead_status_title":{"type":"string"}}},"ApiMessage":{"type":"object","description":"Respuesta genérica de estado para operaciones de escritura y borrado.","properties":{"status":{"type":"boolean","description":"`true` si la operación fue exitosa."},"message":{"type":"string","description":"Mensaje legible del resultado."}}}},"responses":{"Unauthorized":{"description":"Token ausente o inválido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}},"paths":{"/leads/search/{keysearch}":{"get":{"tags":["Leads"],"operationId":"searchLeads","summary":"Buscar leads","description":"Si tu instalación no ofrece esta ruta, usa `/projects/search/{keysearch}`.","parameters":[{"in":"path","name":"keysearch","required":true,"schema":{"type":"string"},"description":"Texto a buscar."}],"responses":{"200":{"description":"Coincidencias de leads.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LeadSearchItem"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developers.myscreators.com/referencia-de-la-api/leads.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.