Contents
On this page

Create Profile - Plugixa Stream

POST /plugixa-stream/v1/me/profiles

Add a profile to the caller’s account.

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

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

Request body

Content type: application/json

Field Type Required Description
name string Yes Up to 30 characters; must not be blank.
avatar integer No 0 to 7. Defaults to the new profile’s id.
kids boolean No A kids profile sees only titles its age rating allows. Defaults to false.
{
  "name": "Leo",
  "avatar": 3,
  "kids": true
}

Responses

201 Created. data is every profile, as in List Profiles.

{
  "success": true,
  "data": {
    "profiles": [
      {
        "id": 0,
        "name": "Maya",
        "avatar": 0,
        "kids": false,
        "main": true
      },
      {
        "id": 1,
        "name": "Leo",
        "avatar": 3,
        "kids": true,
        "main": false
      }
    ],
    "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_profiles_full The account has its most profiles.
422 plugixa_stream_invalid name is blank.

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-stream/v1/me/profiles" \
  -u "$WP_USER:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leo","avatar":3,"kids":true}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/me/profiles');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'name'   => 'Leo',
        'avatar' => 3,
        'kids'   => true,
    ]),
]);
$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', {
  method: 'POST',
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Leo', avatar: 3, kids: true }),
});
const { data } = await response.json();

Quick Links

Share