Prompt to build with AI

Paste this prompt into Claude, ChatGPT, Cursor or your coding assistant before starting an integration. It explains how the API is organized, its conventions and where to read the OpenAPI specification, so it does not invent endpoints.

How to use it

  1. Copy the prompt and replace the highlighted text with what you want to integrate.
  2. Paste it at the start of a new conversation with your AI assistant.
  3. If your assistant can browse or read URLs, ask it to download the OpenAPI specification before writing code.
Prompt

You are going to help me build an integration with the Vixiees public REST API. Vixiees is a sales system for sales teams: contacts, deals, tasks, calls, WhatsApp and Sales Brains (playbooks). ## My goal Describe what you want to integrate, for example: sync Vixiees contacts to my CRM every night ## Source of truth - OpenAPI specification (read it before writing code and check it for every endpoint you use): https://api.vixiees.com/api-docs/v1/swagger.yaml - Do not invent endpoints, fields, parameters or enum values: if it is not in the specification, it does not exist. - Human documentation: https://developers.vixiees.com/en - Summary for models: https://developers.vixiees.com/llms.txt ## Basics - Base URL: https://api.vixiees.com/api/v1 - Authentication: `X-Api-Key: <API_KEY>` header. The key is in Vixiees under Settings β†’ Account β†’ API. Read it from an environment variable (for example `VIXIEES_API_KEY`); never put it in code or in a frontend. - JSON requests and responses, except file uploads, which use multipart when the specification says so. - IDs are 24-character hexadecimal strings. ## Conventions - Pagination: `page` (from 1) and `limit` (100 max). Keep paging until a page returns fewer than `limit` results. - Incremental sync: use each endpoint's date filters (for example `updated_at_from` / `updated_at_to` on `GET /contacts`). - Rate limits: 25 requests per minute per license (Γ—60 per hour, Γ—24 per day) and a hard cap of 40 requests every 2 seconds. On `429`, wait and retry with exponential backoff. - Errors: `{ "error": "message", "details": { ... } }`. Common codes: 400 (invalid parameters), 401 (invalid API key), 404 (not found), 422 (validation or pagination limit), 429 (rate limit). ## Webhooks - Vixiees sends a `POST` to a single URL of yours (set in Settings β†’ Account β†’ API) with the body `{ "event", "payload", "timestamp", "source" }`; `timestamp` is Unix seconds. - Respond 2xx quickly and process in the background. Make the receiver idempotent, so processing the same event twice does not duplicate data. - For real-time changes, use webhooks instead of polling the API. ## API map ### Resources - **Contacts** (Manage contacts (leads and clients)) - `POST /contacts/{contact_id}/calls`: Logs a call made outside Vixiees - `GET /contacts/{contact_id}/documents`: Retrieves documents for a contact - `POST /contacts/{contact_id}/documents`: Uploads a document to a contact - `GET /contacts/{contact_id}/feed`: Retrieves the activity feed for a contact - `GET /contacts/{contact_id}/whatsapp_conversations`: Retrieves whatsapp conversations for a contact - `GET /contacts`: Retrieves contacts - `POST /contacts`: Creates a new contact - `GET /contacts/{id}`: Retrieves a specific contact - `DELETE /contacts/{id}`: Deletes a contact - `PUT /contacts/{id}`: Updates a contact - `POST /contacts/{id}/update_current_playbook`: Updates a contact's current playbook - `POST /contacts/{id}/assign_user`: Assigns a user to a contact - `POST /contacts/{id}/add_comment`: Adds a comment to a contact - **Deals** (Track sales opportunities) - `GET /deals`: Retrieves deals - `POST /deals`: Creates a new deal - `GET /deals/{id}`: Retrieves a deal - `PUT /deals/{id}`: Updates a deal - `DELETE /deals/{id}`: Deletes a deal - **Tasks** (Manage follow-up tasks) - `GET /tasks`: Retrieves tasks - `POST /tasks`: Creates a new task - `POST /tasks/{id}/cancel`: Cancels a task - `POST /tasks/{id}/complete`: Completes a task - **Task Templates** (Task template definitions) - `GET /task_templates`: Retrieves task templates - **Playbooks** (Sales workflow definitions) - `GET /playbooks`: Retrieves all playbooks - **Flow Steps** (Stages within playbooks) - `GET /playbooks/{playbook_id}/flow_steps`: Retrieves flow steps for a playbook - **Contracts** (Contract documents) - `GET /contracts`: Retrieves contracts - **Submitted Forms** (Lead capture forms) - `GET /submitted_forms`: Retrieves submitted forms - `GET /submitted_forms/{id}`: Retrieves a submitted form - **Call Recordings** (Access call recordings) - `GET /call_recordings`: Retrieves call recordings - **WhatsApp Templates** (Send WhatsApp messages) - `GET /whatsapp_templates`: Retrieves WhatsApp templates - `POST /whatsapp_templates/{id}/send_message`: Sends a WhatsApp template message ### Data & Analytics (read-only) - **Dashboard** (Analytics dashboard data export) - `GET /dashboard/leaderboard`: Retrieves dashboard leaderboard - `GET /dashboard/overview`: Retrieves dashboard overview stats - `GET /dashboard/pending_tasks`: Retrieves dashboard tasks distribution - `GET /dashboard/statuses`: Retrieves dashboard flow step transitions - `GET /dashboard/playbook_value`: Retrieves all playbook value dashboard data in one request - **Sales Dashboard** (Per-agent sales dashboard data export) - `GET /sales_dashboard/performance`: Retrieves sales dashboard performance data for a single agent - `GET /sales_dashboard/sales_goals`: Retrieves daily sales goals and their goal/actual records ### Webhooks (events Vixiees sends to your URL) - `contact_created`, `contact_updated`, `contact_deleted`, `contact_comment_created`, `document_created`, `whatsapp_received`, `deal_created`, `deal_updated`, `task_completed`, `incoming_call`, `submitted_form_created` ## How to work 1. If it is unclear what I want to integrate, ask me before writing code. 2. Download the OpenAPI specification and check the exact schema (parameters, body and response) of every endpoint you will use. 3. Write a small, typed client: authentication, pagination, retries on 429 and 5xx, and errors with their `details`. 4. Give me runnable examples and tell me what permissions or settings I need in Vixiees. Note: the MCP server (https://api.vixiees.com/mcp) is for connecting AI assistants to Vixiees, not for system-to-system integrations. Use this REST API for those.

Replace the highlighted text with your own data before sending it.

The endpoint map in the prompt is generated from the published OpenAPI specification, so it is always up to date.