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

Send a message

Request

Send a message via WhatsApp, Instagram, or Facebook Messenger. Requires API key authentication.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
tostringrequired

Recipient identifier. Format depends on channel:

  • WhatsApp: Phone number (e.g., "+573188779043" or "573188779043")
  • Instagram: Instagram user ID (e.g., "828925823321473" or "ig_828925823321473")
  • Facebook Messenger: Facebook user ID (e.g., "123456789" or "fb_123456789")
Example: "+573188779043"
messagestringrequired

Message content

Example: "Hello, how can I help you?"
channelstring

Channel to send message through. If not specified, auto-detected based on 'to' format:

  • whatsapp: Default for phone numbers
  • instagram: For Instagram DMs (prefix 'ig_' in 'to' field)
  • facebook or messenger: For Facebook Messenger (prefix 'fb_' in 'to' field)
Enum"whatsapp""instagram""facebook""messenger"
Example: "whatsapp"
mediaUrlstring(uri)

URL of media file (image, video, audio, document)

mediaTypestring

Type of media if mediaUrl is provided

Enum"image""video""audio""document"
fromstring

Phone number to send from (WhatsApp only, uses default if not specified)

quotedMessageIdstring or null

WhatsApp message ID (wamid.xxx) of the message to quote/reply to (WhatsApp only)

Example: "wamid.HBgMNTczMTg4Nzc5MDQzFQIAERgSOTg5ODFCMTQ5ODMzQTJCOTZGAA=="
quotedMessageMetadataobject or null

Metadata of the quoted message (optional, used for display)

curl -i -X POST \
  https://api.getwipsy.com/functions/v1/api-send-message \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "to": "+573188779043",
    "message": "Hello, how can I help you?"
  }'

Responses

Message sent successfully

Bodyapplication/json
successboolean
messageIdstring

Message ID from the provider

recipientIdstring

Recipient ID (for Instagram/Messenger)

providerstring

Provider used to send the message

Enum"evolution""meta""instagram""messenger"
dataobject

Raw response from the messaging provider

Response
application/json
{
  "success": true,
  "messageId": "string",
  "recipientId": "string",
  "provider": "evolution",
  "data": {}
}

Chats

Retrieve and manage chat conversations

Operations

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