Skip to main content
PUT
/
members
/
{member_id}
/
projects
/
{id}
Update
curl --request PUT \
  --url https://api.beyondwords.io/v1/members/{member_id}/projects/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "favourite": true
}
'
import requests

url = "https://api.beyondwords.io/v1/members/{member_id}/projects/{id}"

payload = { "favourite": True }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({favourite: true})
};

fetch('https://api.beyondwords.io/v1/members/{member_id}/projects/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.beyondwords.io/v1/members/{member_id}/projects/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'favourite' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.beyondwords.io/v1/members/{member_id}/projects/{id}"

payload := strings.NewReader("{\n \"favourite\": true\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.beyondwords.io/v1/members/{member_id}/projects/{id}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"favourite\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/members/{member_id}/projects/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"favourite\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "language": "<string>",
  "language_data": {},
  "logo_color": "<string>",
  "content_total_count": 123,
  "content_updated": "2023-11-07T05:31:56Z",
  "title": {
    "enabled": true,
    "voice": {
      "id": 123,
      "name": "<string>",
      "speaking_rate": 123,
      "multilingual_mode": true,
      "expressiveness": 123,
      "use_speaker_boost": true,
      "similarity_boost": 123,
      "style": 123
    }
  },
  "summary": {
    "enabled": true,
    "voice": {
      "id": 123,
      "name": "<string>",
      "speaking_rate": 123,
      "multilingual_mode": true,
      "expressiveness": 123,
      "use_speaker_boost": true,
      "similarity_boost": 123,
      "style": 123
    }
  },
  "body": {
    "enabled": true,
    "voice": {
      "id": 123,
      "name": "<string>",
      "speaking_rate": 123,
      "multilingual_mode": true,
      "expressiveness": 123,
      "use_speaker_boost": true,
      "similarity_boost": 123,
      "style": 123
    }
  },
  "background_track": {
    "enabled": true,
    "track": {
      "id": 123,
      "name": "<string>",
      "custom": true,
      "volume": 123,
      "url": "<string>"
    }
  },
  "auto_publish_enabled": true,
  "auto_video_publish_enabled": true,
  "time_zone": "<string>",
  "avatar_url": "<string>",
  "pause_after_title_segments_seconds": 1.5,
  "pause_after_segments_seconds": 1.5,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "favourite": true,
  "player_settings": {
    "enabled": true
  },
  "preprocessing_settings": {
    "ai_preprocessing_enabled": true
  },
  "video_settings": {
    "enabled": true
  },
  "summarization_settings": {
    "enabled": true
  },
  "ads": {
    "enabled": true
  }
}

Authorizations

X-Api-Key
string
header
required

Path Parameters

member_id
string
required

The numeric ID of member

id
string
required

id

Body

application/json
favourite
boolean

Response

200 - application/json

successful

id
integer

Unique identifier for the object

name
string

The project name

language
string

The default language of the project (ISO 639-1 code with optional region, e.g., en_GB)

Pattern: ^[a-z]{2}(_[A-Z]{2})?$
language_data
object

Additional language metadata for the project

environment
enum<string> | null
Available options:
production,
staging
logo_color
string | null
content_total_count
integer
content_updated
string<date-time> | null
title
object
summary
object | null
body
object
background_track
object | null
auto_publish_enabled
boolean

When true, automatically distribute content once generated (default is true)

auto_video_publish_enabled
boolean

When true, automatically distribute video content once generated (default is true)

time_zone
string

The project time zone (IANA time zone name)

avatar_url
string<uri> | null

The project's avatar URL

Maximum string length: 2048
pause_after_title_segments_seconds
number
Required range: 0 <= x <= 3
pause_after_segments_seconds
number
Required range: 0 <= x <= 3
created
string<date-time>

Time at which the object was created (ISO 8601)

updated
string<date-time>

Time at which the object was updated (ISO 8601)

favourite
boolean | null

Whether or not the project is favourite

player_settings
object
preprocessing_settings
object
video_settings
object
summarization_settings
object
ads
object