# Wipsy CRM API

### 🚀 Prueba con Datos Reales
Para que esta documentación devuelva datos de tu cuenta en lugar de ejemplos ficticios:
1. Ve a tu panel de Wipsy y obtén tu **API Key**.
2. En el panel derecho de "Try it", haz clic en el botón de **Authentication**.
3. Pega tu clave en el campo **x-api-key**.
4. Asegúrate de tener seleccionado el **Production server** en el selector de servidores.

### Características principales:
- Mensajería multicanal (WhatsApp, Instagram, Facebook Messenger)
- Gestión de Pipeline y embudos de venta
- Sistema de etiquetas y campos personalizados
- Soporte para mensajes citados y estados de entrega (enviado, entregado, leído)
- Autenticación de agentes y permisos segmentados


Version: 1.1.0
License: Proprietary

## Servers

Production server
```
https://api.getwipsy.com/functions/v1
```

## Security

### ApiKeyAuth

API key for authentication (get from your Wipsy dashboard)

Type: apiKey
In: header
Name: x-api-key

### BearerAuth

Bearer token for agent authentication

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Wipsy CRM API](https://wipsy.redocly.app/_bundle/openapi.yaml)

## Messages

Send and manage messages across different channels

### Send a message

 - [POST /api-send-message](https://wipsy.redocly.app/openapi/messages/sendmessage.md): Send a message via WhatsApp, Instagram, or Facebook Messenger.
Requires API key authentication.

## Chats

Retrieve and manage chat conversations

### Get chats

 - [GET /api-get-chats](https://wipsy.redocly.app/openapi/chats/getchats.md): Retrieve chat conversations. Can get all chats or a specific chat by ID.
Requires API key authentication.

## Contacts

Manage customer contacts

### Get contacts

 - [GET /api-get-contacts](https://wipsy.redocly.app/openapi/contacts/getcontacts.md): Retrieve customer contacts. Can get all contacts or a specific contact by ID.
Requires API key authentication.

### Update a contact

 - [POST /api-update-contact](https://wipsy.redocly.app/openapi/contacts/updatecontact.md): Update contact information including name, email, phone, pipeline stage, and custom fields.
Requires API key authentication.

## Agents

Agent authentication and data access

### Get chats for agent

 - [POST /agent-get-chats](https://wipsy.redocly.app/openapi/agents/agentgetchats.md): Retrieve chat conversations for an authenticated agent.
Requires agent session authentication.

### Get messages for a chat (agent)

 - [POST /agent-get-messages](https://wipsy.redocly.app/openapi/agents/agentgetmessages.md): Retrieve messages for a specific chat conversation.
Requires agent session authentication.

## Inventory

Product inventory management

### Get product inventory

 - [GET /inventory-api](https://wipsy.redocly.app/openapi/inventory/getinventory.md): Retrieve product inventory for a user.
Can be accessed via userId or userHash parameter.

## Pipeline

Manage pipeline stages for contacts

### Get pipeline stages

 - [GET /api-get-pipeline-stages](https://wipsy.redocly.app/openapi/pipeline/getpipelinestages.md): Retrieve all pipeline stages for the authenticated user.
Requires API key authentication.

## Tags

Manage tags for contacts and chats

### Get tags

 - [GET /api-get-tags](https://wipsy.redocly.app/openapi/tags/gettags.md): Retrieve all tags for the authenticated user.
Requires API key authentication.

### Assign tag to contact

 - [POST /api-assign-tag](https://wipsy.redocly.app/openapi/tags/assigntag.md): Assign a tag to a contact.
Requires API key authentication.

### Remove tag from contact

 - [POST /api-remove-tag](https://wipsy.redocly.app/openapi/tags/removetag.md): Remove a tag from a contact.
Requires API key authentication.

## CustomFields

Manage custom fields for contacts

### Get custom fields

 - [GET /api-get-custom-fields](https://wipsy.redocly.app/openapi/customfields/getcustomfields.md): Retrieve all custom fields for the authenticated user.
Requires API key authentication.