Update a workspace

Updates a workspace by its public ID

PUT /workspaces/{workspacePublicId}

Update a workspace

cURL

curl --request PUT \
  --url https://opscape.com/api/v1/workspaces/{workspacePublicId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "showEmailsToMembers": true,
  "weekStartDay": 0
}
'

import requests

url = "https://opscape.com/api/v1/workspaces/{workspacePublicId}"

payload = {
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "showEmailsToMembers": True,
    "weekStartDay": 0
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    slug: '<string>',
    description: '<string>',
    showEmailsToMembers: true,
    weekStartDay: 0
  })
};

fetch('https://opscape.com/api/v1/workspaces/{workspacePublicId}', 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://opscape.com/api/v1/workspaces/{workspacePublicId}",
  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([
    'name' => '<string>',
    'slug' => '<string>',
    'description' => '<string>',
    'showEmailsToMembers' => true,
    'weekStartDay' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://opscape.com/api/v1/workspaces/{workspacePublicId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"description\": \"<string>\",\n  \"showEmailsToMembers\": true,\n  \"weekStartDay\": 0\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://opscape.com/api/v1/workspaces/{workspacePublicId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"description\": \"<string>\",\n  \"showEmailsToMembers\": true,\n  \"weekStartDay\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://opscape.com/api/v1/workspaces/{workspacePublicId}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"description\": \"<string>\",\n  \"showEmailsToMembers\": true,\n  \"weekStartDay\": 0\n}"

response = http.request(request)
puts response.read_body

200

{
  "publicId": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "showEmailsToMembers": true,
  "weekStartDay": 123
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspacePublicId · string · required

Minimum string length: 12

Body

application/json

name · string

Required string length: 3 - 64

slug · string

Required string length: 3 - 64

Pattern: ^(?![-]+$)[a-zA-Z0-9-]+$

description · string

Required string length: 3 - 280

showEmailsToMembers · boolean

weekStartDay · Option 1 · enum<number> Option 2 · enum<number> Option 3 · enum<number>

Available options: 0

Response

200

application/json

Successful response

publicId · string · required

name · string · required

slug · string · required

description · string | null · required

plan · enum<string> · required

Available options: free, team, pro, enterprise

showEmailsToMembers · boolean | null · required

weekStartDay · number | null · required