Contents
On this page

Delete Profile - Plugixa Stream

DELETE /plugixa-stream/v1/me/profiles/{id}

Remove a profile, with its progress, My List, likes and reviews. The account’s own profile cannot be removed.

Any signed-in user (an Application Password, or the login cookie with an X-WP-Nonce header). Signed out, it answers 401 plugixa_stream_login_required. It always acts on the caller’s own account. Not from a kids profile: there it answers 403 plugixa_stream_kids_profile.

Request

DELETE https://your-site.example/wp-json/plugixa-stream/v1/me/profiles/1

Path parameters

Name Type Description
id integer The profile, 1 to 9

Responses

200 OK. data is the profiles that remain.

{
  "success": true,
  "data": {
    "profiles": [
      {
        "id": 0,
        "name": "Maya",
        "avatar": 0,
        "kids": false,
        "main": true
      }
    ],
    "active": 0,
    "kids": false,
    "has_pin": true,
    "max": 5,
    "can_add": true,
    "avatars": 8
  }
}

Errors

Status Code When
401 plugixa_stream_login_required Signed out.
403 plugixa_stream_kids_profile The session is on a kids profile.
422 plugixa_stream_profile_main id is 0.
404 plugixa_stream_not_found No such profile.

Plus the errors every endpoint can return.

Examples

curl -s -X DELETE "https://your-site.example/wp-json/plugixa-stream/v1/me/profiles/1" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/me/profiles/1');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => getenv('WP_USER') . ':' . 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-stream/v1/me/profiles/1', {
  method: 'DELETE',
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share