Contacts

Manage contacts (leads and clients)

Logs a call made outside Vixiees

post/contacts/{contact_id}/calls

Records a call that already happened outside Vixiees (another dialer, an AI voice agent, a mobile phone) on the contact.

No call is placed. The call appears in the contact timeline; it does not change the contact's state or tasks. It is not billed and does not count in Vixiees call analytics. When omitted, to (outgoing) or from (incoming) defaults to the contact phone.

Cuerpo de la petición · application/json

  • directionstringobligatorio
    Valores:incomingoutgoing
  • started_atstring (date-time)obligatorio
    ISO 8601, not in the future
    Ejemplo: 2026-10-27T10:00:00Z
  • durationintegerobligatorio
    Duration in seconds; the call cannot end in the future
    Ejemplo: 95
  • response_statusstringobligatorio
    Valores:completedfailedcanceledno_answerbusyblocked_high_riskclosed_officemachine_answeredanswered_but_busyshort_durationdeclined
  • user_idstring
    Vixiees user who made or took the call. Omit it when no Vixiees user was involved (e.g. an AI agent)
    Ejemplo: 64a1b2c3d4e5f678901235fe
  • fromstring
    Calling number, E.164. Defaults to the contact phone for incoming calls
    Ejemplo: +34600000002
  • tostring
    Called number, E.164. Defaults to the contact phone for outgoing calls
    Ejemplo: +34600000001
  • external_reference_idstring
    Your id for this call. If a call with this id was already logged for the account, the request is rejected with 422 and an external_reference_id error, meaning the call already exists
    Ejemplo: dialer-call-8812
  • transcriptarray<object>
    What was said on the call, turn by turn, in order. Up to 100000 characters in total; a longer transcript rejects the whole request. Send it with the call: it cannot be added later. It is stored with the call; it is not shown in the app or returned by the API yet
  • transcript[].speakerstringobligatorio
    agent for whoever spoke on your behalf (a person or an AI agent), contact for the contact
    Valores:agentcontact
  • transcript[].textstringobligatoriopuede ser null
    Turns with an empty or null text are left out
    Ejemplo: Hola, le llamo de Vixiees

Respuestas

  • 200call logged
  • 401unauthorized
  • 404contact not found
  • 422unprocessable entity
Petición
curl -X POST 'https://api.vixiees.com/api/v1/contacts/{contact_id}/calls' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "direction": "outgoing",
  "started_at": "2026-10-27T10:00:00Z",
  "duration": 95,
  "response_status": "completed",
  "user_id": "64a1b2c3d4e5f678901235fe",
  "from": "+34600000002",
  "to": "+34600000001",
  "external_reference_id": "dialer-call-8812",
  "transcript": [
    {
      "speaker": "agent",
      "text": "Hola, le llamo de Vixiees"
    }
  ]
}'
Respuesta de ejemplo · 200
{
  "id": "string"
}

Retrieves documents for a contact

get/contacts/{contact_id}/documents

Returns all files attached to the contact (PDFs, images, etc.).

Each document includes a secure url for downloading the file.

Respuestas

  • 200documents found
  • 401unauthorized
  • 404contact not found
Petición
curl -X GET 'https://api.vixiees.com/api/v1/contacts/{contact_id}/documents' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "results": [
    {
      "id": "string",
      "file_name": "string",
      "file_size": 0,
      "file_content_type": "string",
      "tag": "string",
      "source": "string",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "url": "string"
    }
  ]
}

Uploads a document to a contact

post/contacts/{contact_id}/documents

Uploads a file to the contact. Maximum file size is 35MB.

Use the tag parameter to categorize documents (e.g., "contract", "id", "invoice").

Respuestas

  • 200document created
  • 401unauthorized
  • 404contact not found
  • 422unprocessable entity
Petición
curl -X POST 'https://api.vixiees.com/api/v1/contacts/{contact_id}/documents' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "id": "507f1f77bcf86cd799439011"
}

Retrieves the activity feed for a contact

get/contacts/{contact_id}/feed

Returns a paginated activity feed for a contact, including calls (regular, WhatsApp and calls logged through the API), comments, tasks, emails, SMS messages, and other events.

Items are ordered by occurrence_at descending (most recent first). Use subject_types[] to filter by event type, and from/to to filter by date range.

Parámetros de consulta

  • pageinteger
    Page number (1-based)
    Por defecto: 1
  • limitinteger
    Number of items per page (max 100)
    Por defecto: 25
  • subject_typesarray<string>
    Filter by subject type(s). Valid values: Call, WhatsappCall, ExternalCall, Comment, Task, Sms, Email, PlaybookContactStatus, AssigneeChange, ContactMergeEvent, ContactCreation, DealCreation, Meeting, WorkflowLog, EntityUpdate. Call returns every call type (Call, WhatsappCall, ExternalCall); use WhatsappCall or ExternalCall to narrow it.
  • fromstring (date-time)
    ISO8601 datetime — return items with occurrence_at >= from
  • tostring (date-time)
    ISO8601 datetime — return items with occurrence_at <= to

Respuestas

  • 200feed retrieved
  • 401unauthorized
  • 404contact not found
  • 422invalid date params
Petición
curl -X GET 'https://api.vixiees.com/api/v1/contacts/{contact_id}/feed' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "results": [
    {
      "id": "string",
      "subject_type": "string",
      "subject_id": "string",
      "occurrence_at": "2024-01-01T00:00:00Z",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "subject": {}
    }
  ],
  "page_info": {
    "current_page": 0,
    "limit": 0
  }
}

Retrieves whatsapp conversations for a contact

get/contacts/{contact_id}/whatsapp_conversations

Returns the WhatsApp conversation history for a contact.

Messages include media URLs for attachments (images, documents, audio, video). Both sent and received messages are included with timestamps and delivery status.

For template messages, message_template_body returns the full rendered message (header, body and footer joined by newlines) with the template variables resolved to their sent values when the corresponding parameters are present, instead of raw {{1}}/{{2}} placeholders.

Respuestas

  • 200whatsapp conversations found
  • 401unauthorized
  • 404contact not found
Petición
curl -X GET 'https://api.vixiees.com/api/v1/contacts/{contact_id}/whatsapp_conversations' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "messages": [
    {
      "id": "string",
      "body": "string",
      "sent": true,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "from": "string",
      "to": "string",
      "text": true,
      "status": "string",
      "message_type": "string",
      "message_template_body": "string",
      "template": true,
      "header_parameters": [
        "string"
      ],
      "body_parameters": [
        "string"
      ],
      "buttons_parameters": [
        "string"
      ],
      "url_parameter": "string",
      "wa_id": "string",
      "reply": true,
      "reply_wa_id": "string",
      "attachment": true,
      "image": true,
      "audio": true,
      "video": true,
      "application": true,
      "filename": "string",
      "media_id": "string",
      "media_url": "string",
      "media_content_type": "string",
      "voice": true,
      "location": true,
      "latitude": 0,
      "longitude": 0,
      "label": "string",
      "address": "string"
    }
  ]
}

Retrieves contacts

get/contacts

Returns a paginated list of contacts. Use filters to narrow results:

  • words: Full-text search across name, email, phone, company
  • exact_search: Exact match on email/phone (useful for deduplication)
  • Date filters: created_at_from/to, updated_at_from/to
  • playbook_id/flow_step_id: Restrict to contacts currently in that playbook/flow step

Tip: For webhook-driven sync, filter by updated_at to get only changed records.

Parámetros de consulta

  • playbook_idstring
    Filter by the contact's current playbook ID. A malformed ID returns an empty result set rather than an error.
    Ejemplo: 507f1f77bcf86cd799439011
  • flow_step_idstring
    Filter by the contact's current flow step ID. A malformed ID returns an empty result set rather than an error.
    Ejemplo: 507f1f77bcf86cd799439012
  • wordsstring
    Search terms to filter contacts
    Ejemplo: Jon Smith
  • exact_searchboolean
    Whether to perform an exact match search on email and phone
  • sortstring
    Sort direction (asc or desc)
    Valores:ascdesc
  • order_bystring
    Field to order results by
    Ejemplo: created_at
  • pageinteger
    Page number for pagination
    Ejemplo: 1
  • limitinteger
    Number of records per page
    Ejemplo: 25
  • created_at_fromstring (date-time)
    Filter by creation date from
    Ejemplo: 2024-01-01T00:00:00Z
  • created_at_tostring (date-time)
    Filter by creation date to
    Ejemplo: 2024-12-31T23:59:59Z
  • updated_at_fromstring (date-time)
    Filter by update date from
    Ejemplo: 2024-01-01T00:00:00Z
  • updated_at_tostring (date-time)
    Filter by update date to
    Ejemplo: 2024-12-31T23:59:59Z

Respuestas

  • 200contacts found
  • 401unauthorized
Petición
curl -X GET 'https://api.vixiees.com/api/v1/contacts' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "results": [
    {
      "id": "507f1f77bcf86cd799439011",
      "first_name": "John",
      "last_name": "Doe",
      "second_last_name": "Smith",
      "email": "john.doe@example.com",
      "phone": "+34627352692",
      "company_name": "Acme Corporation",
      "additional_phones": [
        "+34627352693"
      ],
      "additional_emails": [
        "john.doe+work@example.com"
      ],
      "priority": 3,
      "source": "api",
      "country_code": "ES",
      "language": "es",
      "whatsapp_transactional_opt_in": true,
      "email_transactional_opt_in": true,
      "whatsapp_marketing_opt_in": false,
      "email_marketing_opt_in": false,
      "external_reference_id": "EXT-12345",
      "external_reference_url": "https://external-system.com/contacts/12345",
      "ignored": false,
      "is_client": false,
      "last_close_won_reason": "Product demo convinced them",
      "last_close_lost_reason": "Budget constraints",
      "skills": [
        "spanish",
        "english"
      ],
      "created_at": "2023-01-15T10:30:00Z",
      "updated_at": "2023-01-15T14:30:00Z",
      "title": "John Doe",
      "closed_won_reason": "Product demo convinced them",
      "closed_lost_reason": "Budget constraints",
      "custom_attributes": [
        {
          "field_name": "industry",
          "value": "Technology"
        }
      ]
    }
  ],
  "page_info": {
    "current_page": 0,
    "limit": 0
  }
}

Creates a new contact

post/contacts

Creates a new contact. At least one of email or phone is required for WhatsApp/email communication.

Optionally assign the contact to a playbook, flow step, and user at creation time.

Cuerpo de la petición · application/json

  • first_namestring
    Contact first name
    Ejemplo: John
  • last_namestring
    Contact last name
    Ejemplo: Doe
  • second_last_namestring
    Contact second last name
    Ejemplo: Smith
  • emailstring
    Contact email address
    Ejemplo: john.doe@example.com
  • phonestring
    Contact phone number
    Ejemplo: +34627352692
  • company_namestring
    Company name
    Ejemplo: Acme Corporation
  • additional_phonesarray<string>
    Additional phone numbers
    Ejemplo: ["+34627352693","+34627352694"]
  • additional_emailsarray<string>
    Additional email addresses
    Ejemplo: ["john.doe+work@example.com","j.doe@company.com"]
  • sourcestring
    Contact source
    Valores:manualcsvapicallwhatsappemailcrm
  • country_codestring
    Country code (ISO 3166-1 alpha-2)
    Ejemplo: ES
  • languagestring
    Language code (ISO 639-1)
    Ejemplo: es
  • whatsapp_transactional_opt_inboolean
    WhatsApp transactional messages opt-in
    Ejemplo: true
  • email_transactional_opt_inboolean
    Email transactional messages opt-in
    Ejemplo: true
  • whatsapp_marketing_opt_inboolean
    WhatsApp marketing messages opt-in
    Ejemplo: false
  • email_marketing_opt_inboolean
    Email marketing messages opt-in
    Ejemplo: false
  • external_reference_idstring
    External system reference ID
    Ejemplo: EXT-12345
  • external_reference_urlstring
    External system reference URL
    Ejemplo: https://external-system.com/contacts/12345
  • skillsarray<string>
    Contact skills
    Ejemplo: ["spanish","english","sales"]
  • custom_attributesarray<object>puede ser null
  • custom_attributes[].field_namestring
    Ejemplo: industry
  • custom_attributes[].valuestring
    Ejemplo: Technology
  • playbook_idstring
    ID of playbook to assign
    Ejemplo: 507f1f77bcf86cd799439011
  • flow_step_idstring
    ID of flow step to assign
    Ejemplo: 507f1f77bcf86cd799439012
  • assignee_idstring
    ID of user to assign as contact owner
    Ejemplo: 507f1f77bcf86cd799439013

Respuestas

  • 200contact created
  • 401unauthorized
  • 422unprocessable entity
Petición
curl -X POST 'https://api.vixiees.com/api/v1/contacts' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "first_name": "John",
  "last_name": "Doe",
  "second_last_name": "Smith",
  "email": "john.doe@example.com",
  "phone": "+34627352692",
  "company_name": "Acme Corporation",
  "additional_phones": [
    "+34627352693",
    "+34627352694"
  ],
  "additional_emails": [
    "john.doe+work@example.com",
    "j.doe@company.com"
  ],
  "source": "api",
  "country_code": "ES",
  "language": "es",
  "whatsapp_transactional_opt_in": true,
  "email_transactional_opt_in": true,
  "whatsapp_marketing_opt_in": false,
  "email_marketing_opt_in": false,
  "external_reference_id": "EXT-12345",
  "external_reference_url": "https://external-system.com/contacts/12345",
  "skills": [
    "spanish",
    "english",
    "sales"
  ],
  "custom_attributes": [
    {
      "field_name": "industry",
      "value": "Technology"
    }
  ],
  "playbook_id": "507f1f77bcf86cd799439011",
  "flow_step_id": "507f1f77bcf86cd799439012",
  "assignee_id": "507f1f77bcf86cd799439013"
}'
Respuesta de ejemplo · 200
{
  "id": "string"
}

Retrieves a specific contact

get/contacts/{id}

Returns a single contact with all fields including custom attributes.

You can use either the internal ID or the external_reference_id to retrieve the contact.

Parámetros de ruta

  • idstringobligatorio
    The ID or external reference ID of the contact to retrieve
    Ejemplo: 64a1b2c3d4e5f678901234ab

Respuestas

  • 200contact found
  • 401unauthorized
  • 404contact not found
Petición
curl -X GET 'https://api.vixiees.com/api/v1/contacts/64a1b2c3d4e5f678901234ab' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "id": "507f1f77bcf86cd799439011",
  "first_name": "John",
  "last_name": "Doe",
  "second_last_name": "Smith",
  "email": "john.doe@example.com",
  "phone": "+34627352692",
  "company_name": "Acme Corporation",
  "additional_phones": [
    "+34627352693"
  ],
  "additional_emails": [
    "john.doe+work@example.com"
  ],
  "source": "api",
  "country_code": "ES",
  "language": "es",
  "whatsapp_transactional_opt_in": true,
  "email_transactional_opt_in": true,
  "whatsapp_marketing_opt_in": false,
  "email_marketing_opt_in": false,
  "external_reference_id": "EXT-12345",
  "external_reference_url": "https://external-system.com/contacts/12345",
  "skills": [
    "spanish",
    "english"
  ],
  "custom_attributes": [
    {
      "field_name": "industry",
      "value": "Technology"
    }
  ]
}

Deletes a contact

DEL/contacts/{id}

Deletes a contact. All associated tasks and deals will be preserved but no longer visible in the app.

Parámetros de ruta

  • idstringobligatorio
    The ID or external reference ID of the contact to delete

Respuestas

  • 200contact deleted
  • 401unauthorized
  • 404contact not found
Petición
curl -X DELETE 'https://api.vixiees.com/api/v1/contacts/{id}' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "status": "ok"
}

Updates a contact

put/contacts/{id}

Partial update of a contact. Only provided fields are modified; omitted fields remain unchanged.

Custom attributes can be updated by including them in the custom_attributes array.

Parámetros de ruta

  • idstringobligatorio
    The ID or external reference ID of the contact to update
    Ejemplo: 64a1b2c3d4e5f678901234ab

Cuerpo de la petición · application/json

  • first_namestring
    Contact first name
    Ejemplo: John
  • last_namestring
    Contact last name
    Ejemplo: Doe
  • second_last_namestring
    Contact second last name
    Ejemplo: Smith
  • emailstring
    Contact email address
    Ejemplo: john.doe@example.com
  • phonestring
    Contact phone number
    Ejemplo: +34627352692
  • company_namestring
    Company name
    Ejemplo: Acme Corporation
  • additional_phonesarray<string>
    Additional phone numbers
    Ejemplo: ["+34627352693","+34627352694"]
  • additional_emailsarray<string>
    Additional email addresses
    Ejemplo: ["john.doe+work@example.com","j.doe@company.com"]
  • priorityinteger
    Contact priority (1-5)
    Valores:12345
  • sourcestring
    Contact source
    Valores:manualcsvapicallwhatsappemailcrm
  • country_codestring
    Country code (ISO 3166-1 alpha-2)
    Ejemplo: ES
  • languagestring
    Language code (ISO 639-1)
    Ejemplo: es
  • whatsapp_transactional_opt_inboolean
    WhatsApp transactional messages opt-in
    Ejemplo: true
  • email_transactional_opt_inboolean
    Email transactional messages opt-in
    Ejemplo: true
  • whatsapp_marketing_opt_inboolean
    WhatsApp marketing messages opt-in
    Ejemplo: false
  • email_marketing_opt_inboolean
    Email marketing messages opt-in
    Ejemplo: false
  • external_reference_idstring
    External system reference ID
    Ejemplo: EXT-12345
  • external_reference_urlstring
    External system reference URL
    Ejemplo: https://external-system.com/contacts/12345
  • skillsarray<string>
    Contact skills
    Ejemplo: ["spanish","english","sales"]
  • custom_attributesarray<object>puede ser null
  • custom_attributes[].field_namestring
    Ejemplo: industry
  • custom_attributes[].valuestring
    Ejemplo: Technology

Respuestas

  • 200contact updated
  • 401unauthorized
  • 404contact not found
Petición
curl -X PUT 'https://api.vixiees.com/api/v1/contacts/64a1b2c3d4e5f678901234ab' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "first_name": "John",
  "last_name": "Doe",
  "second_last_name": "Smith",
  "email": "john.doe@example.com",
  "phone": "+34627352692",
  "company_name": "Acme Corporation",
  "additional_phones": [
    "+34627352693",
    "+34627352694"
  ],
  "additional_emails": [
    "john.doe+work@example.com",
    "j.doe@company.com"
  ],
  "priority": 3,
  "source": "api",
  "country_code": "ES",
  "language": "es",
  "whatsapp_transactional_opt_in": true,
  "email_transactional_opt_in": true,
  "whatsapp_marketing_opt_in": false,
  "email_marketing_opt_in": false,
  "external_reference_id": "EXT-12345",
  "external_reference_url": "https://external-system.com/contacts/12345",
  "skills": [
    "spanish",
    "english",
    "sales"
  ],
  "custom_attributes": [
    {
      "field_name": "industry",
      "value": "Technology"
    }
  ]
}'
Respuesta de ejemplo · 200
{
  "id": "507f1f77bcf86cd799439011",
  "first_name": "John",
  "last_name": "Doe",
  "second_last_name": "Smith",
  "email": "john.doe@example.com",
  "phone": "+34627352692",
  "company_name": "Acme Corporation",
  "additional_phones": [
    "+34627352693"
  ],
  "additional_emails": [
    "john.doe+work@example.com"
  ],
  "priority": 3,
  "source": "api",
  "country_code": "ES",
  "language": "es",
  "whatsapp_transactional_opt_in": true,
  "email_transactional_opt_in": true,
  "whatsapp_marketing_opt_in": false,
  "email_marketing_opt_in": false,
  "external_reference_id": "EXT-12345",
  "external_reference_url": "https://external-system.com/contacts/12345",
  "ignored": false,
  "is_client": false,
  "last_close_won_reason": "Product demo convinced them",
  "last_close_lost_reason": "Budget constraints",
  "skills": [
    "spanish",
    "english"
  ],
  "created_at": "2023-01-15T10:30:00Z",
  "updated_at": "2023-01-15T14:30:00Z",
  "title": "John Doe",
  "closed_won_reason": "Product demo convinced them",
  "closed_lost_reason": "Budget constraints",
  "custom_attributes": [
    {
      "field_name": "industry",
      "value": "Technology"
    }
  ]
}

Updates a contact's current playbook

post/contacts/{id}/update_current_playbook

Moves a contact to a different playbook and/or flow step.

Use this to progress contacts through your sales pipeline or reassign them to different workflows. Optionally update contact fields at the same time using contact_required_fields.

Parámetros de ruta

  • idstringobligatorio
    The ID or external reference ID of the contact
    Ejemplo: 64a1b2c3d4e5f678901234ab

Cuerpo de la petición · application/json

  • playbook_idstringobligatorio
    Ejemplo: 64a1b2c3d4e5f678901234cd
  • flow_step_idstring
    Ejemplo: 64a1b2c3d4e5f678901234ef
  • contact_required_fieldsarray<object>
    Optional array of contact fields to update along with the playbook change
    Ejemplo: [{"key":"custom_field_name","value":"custom_value"}]
  • contact_required_fields[].keystringobligatorio
    Field name (can be a contact attribute or custom attribute)
    Ejemplo: custom_field_name
  • contact_required_fields[].valuestringobligatorio
    Field value
    Ejemplo: custom_value

Respuestas

  • 200playbook updated with contact required fields
  • 401unauthorized
  • 404contact not found
Petición
curl -X POST 'https://api.vixiees.com/api/v1/contacts/64a1b2c3d4e5f678901234ab/update_current_playbook' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "playbook_id": "64a1b2c3d4e5f678901234cd",
  "flow_step_id": "64a1b2c3d4e5f678901234ef",
  "contact_required_fields": [
    {
      "key": "custom_field_name",
      "value": "custom_value"
    }
  ]
}'
Respuesta de ejemplo · 200
{
  "id": "507f1f77bcf86cd799439011",
  "first_name": "John",
  "last_name": "Doe",
  "second_last_name": "Smith",
  "email": "john.doe@example.com",
  "phone": "+34627352692",
  "company_name": "Acme Corporation",
  "additional_phones": [
    "+34627352693"
  ],
  "additional_emails": [
    "john.doe+work@example.com"
  ],
  "priority": 3,
  "source": "api",
  "country_code": "ES",
  "language": "es",
  "whatsapp_transactional_opt_in": true,
  "email_transactional_opt_in": true,
  "whatsapp_marketing_opt_in": false,
  "email_marketing_opt_in": false,
  "external_reference_id": "EXT-12345",
  "external_reference_url": "https://external-system.com/contacts/12345",
  "ignored": false,
  "is_client": false,
  "last_close_won_reason": "Product demo convinced them",
  "last_close_lost_reason": "Budget constraints",
  "skills": [
    "spanish",
    "english"
  ],
  "created_at": "2023-01-15T10:30:00Z",
  "updated_at": "2023-01-15T14:30:00Z",
  "title": "John Doe",
  "closed_won_reason": "Product demo convinced them",
  "closed_lost_reason": "Budget constraints",
  "custom_attributes": [
    {
      "field_name": "industry",
      "value": "Technology"
    }
  ]
}

Assigns a user to a contact

post/contacts/{id}/assign_user

Assigns a team member to be the owner of this contact.

The assigned user will see this contact in their task queue and receive notifications.

Parámetros de ruta

  • idstringobligatorio
    The ID or external reference ID of the contact
    Ejemplo: 64a1b2c3d4e5f678901234ab

Cuerpo de la petición · application/json

  • assignee_idstringobligatorio
    Ejemplo: 64a1b2c3d4e5f678901234gh

Respuestas

  • 200user assigned
  • 401unauthorized
  • 404contact not found
Petición
curl -X POST 'https://api.vixiees.com/api/v1/contacts/64a1b2c3d4e5f678901234ab/assign_user' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "assignee_id": "64a1b2c3d4e5f678901234gh"
}'
Respuesta de ejemplo · 200
{
  "status": "string"
}

Adds a comment to a contact

post/contacts/{id}/add_comment

Adds a comment to a contact's activity feed.

Comments are visible in the contact timeline and can be synced to integrated CRMs (Hubspot, Pipedrive).

Parámetros de ruta

  • idstringobligatorio
    The ID or external reference ID of the contact
    Ejemplo: 64a1b2c3d4e5f678901234ab

Cuerpo de la petición · application/json

  • contentstringobligatorio
    The comment text
    Ejemplo: Called the contact, left voicemail.

Respuestas

  • 200comment added
  • 401unauthorized
  • 404contact not found
  • 422validation failed
Petición
curl -X POST 'https://api.vixiees.com/api/v1/contacts/64a1b2c3d4e5f678901234ab/add_comment' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "content": "Called the contact, left voicemail."
}'
Respuesta de ejemplo · 200
{
  "id": "string"
}