Contents
On this page
Update Profile - Plugixa Stream
PUT /plugixa-stream/v1/me/profiles/{id}
Change one of the caller’s profiles. The account’s own profile (0) can change its name and avatar, never become a kids profile.
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
PUT https://your-site.example/wp-json/plugixa-stream/v1/me/profiles/1
Path parameters
| Name | Type | Description |
|---|---|---|
id |
integer |
The profile, 0 to 9 |
Request body
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
name |
string |
No | Up to 30 characters; must not be blank. |
avatar |
integer |
No | 0 to 7. |
kids |
boolean |
No | Kids mode. Ignored on profile 0. |
{
"name": "Leo",
"kids": false
}
Responses
200 OK. data is every profile.
{
"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. |
404 |
plugixa_stream_not_found |
No such profile. |
422 |
plugixa_stream_invalid |
name is blank. |
400 |
rest_invalid_param |
id is above 9. |
Plus the errors every endpoint can return.
Examples
curl -s -X PUT "https://your-site.example/wp-json/plugixa-stream/v1/me/profiles/1" \
-u "$WP_USER:$WP_APP_PASSWORD" \
-H "Content-Type: application/json" \
-d '{"name":"Leo","kids":false}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/me/profiles/1');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Leo',
'kids' => false,
]),
]);
$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: 'PUT',
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ name: 'Leo', kids: false }),
});
const { data } = await response.json();
Quick Links
Share