Contents
On this page

Update CRM Connection - Plugixa Chat

PUT /plugixa-chat/v1/crm/{id}

Replace a connection’s list, tags and options, and optionally its key. PUT and PATCH behave the same.

Needs Plugixa Chat Pro. The signed-in user needs the plugixa_chat_edit capability. Administrators have it.

Note. This is a full replace, even with PATCH: list_id is required every time, and name, list_name, tags, double_optin, audience and widget_id you leave out go back to their defaults. A missing is_active becomes true, so it switches a paused connection back on. Saving also clears failures and last_error.

Request

PUT https://your-site.example/wp-json/plugixa-chat/v1/crm/6

Path parameters

Name Type Description
id integer The connection’s id

Request body

Content type: application/json

Field Type Required Description
list_id string Yes The list to add contacts to. Get the ids with List CRM Lists.
api_key string No A new key. Empty or left out keeps the stored one.
list_name string No The list’s name, for display.
name string No Your label. Defaults to list_name, else the service’s name.
tags array No Up to 10 tags of up to 100 characters. Kept for Mailchimp and FluentCRM only.
double_optin boolean No Ask the contact to confirm. Kept for Mailchimp and FluentCRM only.
audience string No subscribed (the default) or everyone.
widget_id integer No Only send leads from this widget. 0 (the default) for all.
is_active boolean No Defaults to true.

The service cannot change: provider is ignored, and the saved one is kept.

{
  "list_id": "a1b2c3d4e5",
  "list_name": "Newsletter",
  "tags": [
    "chat-lead",
    "website"
  ],
  "double_optin": true,
  "audience": "everyone"
}

Responses

200 OK. data is the updated connection.

{
  "success": true,
  "data": {
    "id": 6,
    "provider": "mailchimp",
    "name": "Newsletter",
    "list_id": "a1b2c3d4e5",
    "list_name": "Newsletter",
    "tags": [
      "chat-lead",
      "website"
    ],
    "double_optin": true,
    "audience": "everyone",
    "widget_id": 0,
    "is_active": true,
    "last_status": 0,
    "last_error": "",
    "last_sent_at": null,
    "failures": 0,
    "deleted_at": null,
    "created_at": "2026-11-12 09:30:00",
    "modified_at": "2026-11-12 09:30:00",
    "created_by": "1",
    "modified_by": "1",
    "has_key": true
  }
}
Field Type Meaning
data.id integer The connection’s id
data.tags array Tags added to each contact
data.double_optin boolean Whether the service asks the contact to confirm
data.audience string subscribed (only leads who ticked the newsletter box) or everyone
data.failures integer Failures in a row
data.has_key boolean Whether an API key is stored. The key itself is never returned

Errors

Status Code When
404 plugixa_chat_crm_missing No connection has this id, or it is in the trash.
400 plugixa_chat_crm_list list_id is missing or blank.

Plus the errors every endpoint can return.

Examples

curl -s -X PUT "https://your-site.example/wp-json/plugixa-chat/v1/crm/6" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"list_id":"a1b2c3d4e5","list_name":"Newsletter","tags":["chat-lead","website"],"double_optin":true,"audience":"everyone"}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-chat/v1/crm/6');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'list_id'      => 'a1b2c3d4e5',
        'list_name'    => 'Newsletter',
        'tags'         => ['chat-lead', 'website'],
        'double_optin' => true,
        'audience'     => 'everyone',
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-chat/v1/crm/6', {
  method: 'PUT',
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ list_id: 'a1b2c3d4e5', list_name: 'Newsletter', tags: ['chat-lead', 'website'], double_optin: true, audience: 'everyone' }),
});
const { data } = await response.json();

Quick Links

Share