Skip to content

Wipsy CRM API (1.1.0)

API documentation for Wipsy CRM - A multi-channel customer relationship management platform.

🚀 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
Download OpenAPI description
openapi.json
openapi.yaml
Overview
Wipsy Support
support@wipsy.com
License
Proprietary
Languages
Servers
Production server
https://api.getwipsy.com/functions/v1

Messages

Send and manage messages across different channels

Operations

Chats

Retrieve and manage chat conversations

Operations

Get chats

Request

Retrieve chat conversations. Can get all chats or a specific chat by ID. Requires API key authentication.

Security
ApiKeyAuth
Query
chatIdstring(uuid)

Specific chat ID to retrieve (optional)

limitinteger[ 1 .. 100 ]

Maximum number of chats to return

Default 50
curl -i -X GET \
  'https://api.getwipsy.com/functions/v1/api-get-chats?chatId=497f6eca-6276-4993-bfeb-53cbbbba6f08&limit=50' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Chats retrieved successfully

Bodyapplication/json
successboolean
dataChat (object) or Array of Chat (objects)
One of:
chat_buttonsArray of objects(ChatButton)

Chat buttons configured for the user account

Response
application/json
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
    "channel_type": "whatsapp",
    "status": "active",
    "last_message_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "customer": { … },
    "messages": [ … ]
  },
  "chat_buttons": [
    { … }
  ]
}

Update chat button configuration

Request

Update a chat button's global configuration (name, icon, color, etc.). This updates the button definition, not its state for a specific chat. Requires API key authentication.

Security
ApiKeyAuth
Query
buttonIdstring(uuid)required

ID of the chat button to update

Bodyapplication/jsonrequired
is_enabledboolean

Enable or disable the button globally

Example: true
namestring

Button display name

Example: "Agente"
iconstring

Icon identifier

Example: "bot"
colorstring

Button color (hex format)

Example: "#3B82F6"
is_toggleboolean

Whether this is a toggle button

Example: true
positioninteger

Display order/position

Example: 0
curl -i -X PUT \
  'https://api.getwipsy.com/functions/v1/api-update-chat-button?buttonId=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "is_enabled": true,
    "name": "Agente",
    "icon": "bot",
    "color": "#3B82F6",
    "is_toggle": true,
    "position": 0
  }'

Responses

Chat button updated successfully

Bodyapplication/json
successboolean
dataobject(ChatButton)

Chat button configuration for the chat header

Response
application/json
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "name": "Agente",
    "icon": "robot",
    "color": "#3B82F6",
    "is_toggle": true,
    "is_enabled": true,
    "position": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Update chat button state for a specific chat

Request

Enable or disable a chat button for a specific chat/conversation. Chat buttons are associated with conversations, not contacts. Requires API key authentication.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
chat_idstring(uuid)required

ID of the chat/conversation

button_idstring(uuid)required

ID of the chat button

is_enabledbooleanrequired

Whether to enable (true) or disable (false) the button for this chat

curl -i -X POST \
  https://api.getwipsy.com/functions/v1/api-update-chat-button-state \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "chat_id": "123e4567-e89b-12d3-a456-426614174000",
    "button_id": "987fcdeb-51a2-3bc4-d567-890123456789",
    "is_enabled": true
  }'

Responses

Button state updated successfully

Bodyapplication/json
successboolean
dataobject
messagestring
Example: "Button \"Agente\" has been enabled for this chat"
Response
application/json
{
  "success": true,
  "data": {
    "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
    "button_id": "058950a8-fc22-47cc-9c60-8db6ab5ae0d2",
    "button_name": "string",
    "is_enabled": true
  },
  "message": "Button \"Agente\" has been enabled for this chat"
}

Contacts

Manage customer contacts

Operations

Agents

Agent authentication and data access

Operations

Inventory

Product inventory management

Operations

Pipeline

Manage pipeline stages for contacts

Operations

Tags

Manage tags for contacts and chats

Operations

CustomFields

Manage custom fields for contacts

Operations