Restore Agent - Plugixa Chat for WordPress

Restore Agent - Plugixa Chat

POST /plugixa-chat/v1/agents/{id}/restore

Bring a trashed agent back, exactly as it was when it was deleted.

Needs Plugixa Chat Pro. The signed-in user needs the plugixa_chat_delete capability, the same one deleting needs. Administrators have it.

Note. A agent that is not in the trash answers 404, the same as an id that does not exist.

Request

POST https://your-site.example/wp-json/plugixa-chat/v1/agents/4/restore

Path parameters

Name	Type	Description
`id`	`integer`	The agent’s id

Responses

`200` OK. The agent is live again.

{
  "success": true,
  "data": {
    "restored": true
  }
}

Field	Type	Meaning
`data.restored`	`boolean`	Always `true`

Errors

Status	Code	When
`404`	`plugixa_chat_not_found`	No agent has this id, or it is not in the trash.

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-chat/v1/agents/4/restore" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-chat/v1/agents/4/restore');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-chat/v1/agents/4/restore', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data } = await response.json();