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

Contacts

Manage customer contacts

Operations

Get contacts

Request

Retrieve customer contacts. Can get all contacts or a specific contact by ID. Requires API key authentication.

Note: Chat buttons are associated with conversations (chats), not contacts. Use the /api-get-chats endpoint to retrieve chat button states.

Security
ApiKeyAuth
Query
contactIdstring(uuid)

Specific contact ID to retrieve (optional)

limitinteger[ 1 .. 500 ]

Maximum number of contacts to return

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

Responses

Contacts retrieved successfully

Bodyapplication/json
successboolean
dataContact (object) or Array of Contact (objects)
One of:
Response
application/json
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "name": "string",
    "last_name": "string",
    "phone": "string",
    "whatsapp_id": "string",
    "email": "string",
    "profile_picture_url": "http://example.com",
    "pipeline_stage_id": "16ac276d-82f6-4f2a-bbab-e2e260c45fe4",
    "pipeline_stage": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "tags": [ … ],
    "custom_fields": [ … ]
  }
}

Get chat buttons

Request

Retrieve all chat buttons configured for the user account. Requires API key authentication.

Security
ApiKeyAuth
curl -i -X GET \
  https://api.getwipsy.com/functions/v1/api-get-chat-buttons \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Chat buttons retrieved successfully

Bodyapplication/json
successboolean
dataArray of objects(ChatButton)
Response
application/json
{
  "success": true,
  "data": [
    { … }
  ]
}

Create a contact

Request

Create a new contact with optional tags, custom fields, and pipeline stage assignment. Requires API key authentication.

Note: Free plan users have a monthly limit of 100 contacts. If the limit is reached, the request will return a 429 status code.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
namestringrequired

Contact's first name

Example: "John"
last_namestring or null

Contact's last name

Example: "Doe"
phonestring or null

Contact's phone number (will be normalized automatically)

Example: "+573188779043"
emailstring or null(email)

Contact's email address

Example: "john.doe@example.com"
whatsapp_idstring or null

WhatsApp ID (defaults to phone if not provided)

Example: "+573188779043"
pipeline_stage_idstring or null(uuid)

Pipeline stage ID to assign to this contact

profile_picture_urlstring or null(uri)

URL to the contact's profile picture

addressstring or null

Contact's address

citystring or null

Contact's city

provincestring or null

Contact's province/state

companystring or null

Contact's company name

notesstring or null

Additional notes about the contact

tagsArray of strings(uuid)

Array of tag IDs to assign to the contact

Example: ["tag-uuid-1","tag-uuid-2"]
custom_fieldsobject

Custom field values (field_id: value pairs)

Example: {"field-uuid-1":"Value 1","field-uuid-2":"Value 2"}
curl -i -X POST \
  https://api.getwipsy.com/functions/v1/api-create-contact \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "John",
    "last_name": "Doe",
    "phone": "+573188779043",
    "email": "john.doe@example.com"
  }'

Responses

Contact created successfully

Bodyapplication/json
successboolean
dataobject(Contact)
messagestring
Example: "Contact created successfully"
Response
application/json
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "name": "string",
    "last_name": "string",
    "phone": "string",
    "whatsapp_id": "string",
    "email": "string",
    "profile_picture_url": "http://example.com",
    "pipeline_stage_id": "16ac276d-82f6-4f2a-bbab-e2e260c45fe4",
    "pipeline_stage": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "tags": [ … ],
    "custom_fields": [ … ]
  },
  "message": "Contact created successfully"
}

Update a contact

Request

Update contact information including name, email, phone, pipeline stage, and custom fields. Requires API key authentication.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
contactIdstring(uuid)required
namestring
last_namestring or null
emailstring or null
phonestring
pipeline_stage_idstring or null(uuid)

Pipeline stage ID to assign to this contact

custom_fieldsobject

Custom field values (field_id: value pairs)

curl -i -X POST \
  https://api.getwipsy.com/functions/v1/api-update-contact \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
    "name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "pipeline_stage_id": "16ac276d-82f6-4f2a-bbab-e2e260c45fe4",
    "custom_fields": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

Contact updated successfully

Bodyapplication/json
successboolean
dataobject(Contact)
Response
application/json
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "name": "string",
    "last_name": "string",
    "phone": "string",
    "whatsapp_id": "string",
    "email": "string",
    "profile_picture_url": "http://example.com",
    "pipeline_stage_id": "16ac276d-82f6-4f2a-bbab-e2e260c45fe4",
    "pipeline_stage": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "tags": [ … ],
    "custom_fields": [ … ]
  }
}

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