Patch v2orgs

Update an organization

PATCH /v2/orgs/{orgSlug}

cURL

cURL

curl --request PATCH \
  --url https://api.eda.prisme.ai/v2/orgs/{orgSlug} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "id": "<string>",
  "description": "<string>",
  "photo": "<string>",
  "domains": [
    "<string>"
  ],
  "branding": {
    "version": "<string>",
    "platformName": "<string>",
    "description": "<string>",
    "logo": {
      "light": "<string>",
      "dark": "<string>"
    },
    "favicon": "<string>",
    "colors": {
      "primary": "<string>",
      "secondary": "<string>",
      "accent": "<string>"
    },
    "fonts": {
      "heading": "<string>",
      "body": "<string>"
    },
    "customCssUrl": "<string>",
    "customCssInline": "<string>"
  },
  "navigation": {
    "version": 123,
    "homePage": "<string>",
    "menu": [
      {
        "id": "<string>",
        "label": "<string>",
        "icon": "<string>",
        "color": "<string>",
        "href": "<string>",
        "expanded": true,
        "badge": "<string>",
        "permissions": [
          "<string>"
        ],
        "features": [
          {
            "slug": "<string>",
            "label": "<string>",
            "agentId": "<string>",
            "templateId": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "visibility": {
          "tiers": [
            "<string>"
          ],
          "features": [
            "<string>"
          ]
        },
        "items": "<array>"
      }
    ],
    "footer": [
      {
        "id": "<string>",
        "label": "<string>",
        "icon": "<string>",
        "color": "<string>",
        "href": "<string>",
        "expanded": true,
        "badge": "<string>",
        "permissions": [
          "<string>"
        ],
        "features": [
          {
            "slug": "<string>",
            "label": "<string>",
            "agentId": "<string>",
            "templateId": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "visibility": {
          "tiers": [
            "<string>"
          ],
          "features": [
            "<string>"
          ]
        },
        "items": "<array>"
      }
    ],
    "quickActions": [
      {
        "id": "<string>",
        "label": "<string>",
        "icon": "<string>",
        "color": "<string>",
        "href": "<string>",
        "expanded": true,
        "badge": "<string>",
        "permissions": [
          "<string>"
        ],
        "features": [
          {
            "slug": "<string>",
            "label": "<string>",
            "agentId": "<string>",
            "templateId": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "visibility": {
          "tiers": [
            "<string>"
          ],
          "features": [
            "<string>"
          ]
        },
        "items": "<array>"
      }
    ]
  },
  "joinRules": [
    {
      "rules": [
        {
          "field": "<string>",
          "value": "<string>"
        }
      ],
      "role": "<string>",
      "groups": [
        "<string>"
      ]
    }
  ],
  "defaultRole": "<string>",
  "settings": {},
  "subscriptionSlug": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}
'

import requests

url = "https://api.eda.prisme.ai/v2/orgs/{orgSlug}"

payload = {
    "name": "<string>",
    "slug": "<string>",
    "id": "<string>",
    "description": "<string>",
    "photo": "<string>",
    "domains": ["<string>"],
    "branding": {
        "version": "<string>",
        "platformName": "<string>",
        "description": "<string>",
        "logo": {
            "light": "<string>",
            "dark": "<string>"
        },
        "favicon": "<string>",
        "colors": {
            "primary": "<string>",
            "secondary": "<string>",
            "accent": "<string>"
        },
        "fonts": {
            "heading": "<string>",
            "body": "<string>"
        },
        "customCssUrl": "<string>",
        "customCssInline": "<string>"
    },
    "navigation": {
        "version": 123,
        "homePage": "<string>",
        "menu": [
            {
                "id": "<string>",
                "label": "<string>",
                "icon": "<string>",
                "color": "<string>",
                "href": "<string>",
                "expanded": True,
                "badge": "<string>",
                "permissions": ["<string>"],
                "features": [
                    {
                        "slug": "<string>",
                        "label": "<string>",
                        "agentId": "<string>",
                        "templateId": "<string>",
                        "permissions": ["<string>"]
                    }
                ],
                "visibility": {
                    "tiers": ["<string>"],
                    "features": ["<string>"]
                },
                "items": "<array>"
            }
        ],
        "footer": [
            {
                "id": "<string>",
                "label": "<string>",
                "icon": "<string>",
                "color": "<string>",
                "href": "<string>",
                "expanded": True,
                "badge": "<string>",
                "permissions": ["<string>"],
                "features": [
                    {
                        "slug": "<string>",
                        "label": "<string>",
                        "agentId": "<string>",
                        "templateId": "<string>",
                        "permissions": ["<string>"]
                    }
                ],
                "visibility": {
                    "tiers": ["<string>"],
                    "features": ["<string>"]
                },
                "items": "<array>"
            }
        ],
        "quickActions": [
            {
                "id": "<string>",
                "label": "<string>",
                "icon": "<string>",
                "color": "<string>",
                "href": "<string>",
                "expanded": True,
                "badge": "<string>",
                "permissions": ["<string>"],
                "features": [
                    {
                        "slug": "<string>",
                        "label": "<string>",
                        "agentId": "<string>",
                        "templateId": "<string>",
                        "permissions": ["<string>"]
                    }
                ],
                "visibility": {
                    "tiers": ["<string>"],
                    "features": ["<string>"]
                },
                "items": "<array>"
            }
        ]
    },
    "joinRules": [
        {
            "rules": [
                {
                    "field": "<string>",
                    "value": "<string>"
                }
            ],
            "role": "<string>",
            "groups": ["<string>"]
        }
    ],
    "defaultRole": "<string>",
    "settings": {},
    "subscriptionSlug": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    slug: '<string>',
    id: '<string>',
    description: '<string>',
    photo: '<string>',
    domains: ['<string>'],
    branding: {
      version: '<string>',
      platformName: '<string>',
      description: '<string>',
      logo: {light: '<string>', dark: '<string>'},
      favicon: '<string>',
      colors: {primary: '<string>', secondary: '<string>', accent: '<string>'},
      fonts: {heading: '<string>', body: JSON.stringify('<string>')},
      customCssUrl: '<string>',
      customCssInline: '<string>'
    },
    navigation: {
      version: 123,
      homePage: '<string>',
      menu: [
        {
          id: '<string>',
          label: '<string>',
          icon: '<string>',
          color: '<string>',
          href: '<string>',
          expanded: true,
          badge: '<string>',
          permissions: ['<string>'],
          features: [
            {
              slug: '<string>',
              label: '<string>',
              agentId: '<string>',
              templateId: '<string>',
              permissions: ['<string>']
            }
          ],
          visibility: {tiers: ['<string>'], features: ['<string>']},
          items: '<array>'
        }
      ],
      footer: [
        {
          id: '<string>',
          label: '<string>',
          icon: '<string>',
          color: '<string>',
          href: '<string>',
          expanded: true,
          badge: '<string>',
          permissions: ['<string>'],
          features: [
            {
              slug: '<string>',
              label: '<string>',
              agentId: '<string>',
              templateId: '<string>',
              permissions: ['<string>']
            }
          ],
          visibility: {tiers: ['<string>'], features: ['<string>']},
          items: '<array>'
        }
      ],
      quickActions: [
        {
          id: '<string>',
          label: '<string>',
          icon: '<string>',
          color: '<string>',
          href: '<string>',
          expanded: true,
          badge: '<string>',
          permissions: ['<string>'],
          features: [
            {
              slug: '<string>',
              label: '<string>',
              agentId: '<string>',
              templateId: '<string>',
              permissions: ['<string>']
            }
          ],
          visibility: {tiers: ['<string>'], features: ['<string>']},
          items: '<array>'
        }
      ]
    },
    joinRules: [
      {
        rules: [{field: '<string>', value: '<string>'}],
        role: '<string>',
        groups: ['<string>']
      }
    ],
    defaultRole: '<string>',
    settings: {},
    subscriptionSlug: '<string>',
    createdBy: '<string>',
    updatedBy: '<string>',
    createdAt: '<string>',
    updatedAt: '<string>'
  })
};

fetch('https://api.eda.prisme.ai/v2/orgs/{orgSlug}', 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.eda.prisme.ai/v2/orgs/{orgSlug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'slug' => '<string>',
    'id' => '<string>',
    'description' => '<string>',
    'photo' => '<string>',
    'domains' => [
        '<string>'
    ],
    'branding' => [
        'version' => '<string>',
        'platformName' => '<string>',
        'description' => '<string>',
        'logo' => [
                'light' => '<string>',
                'dark' => '<string>'
        ],
        'favicon' => '<string>',
        'colors' => [
                'primary' => '<string>',
                'secondary' => '<string>',
                'accent' => '<string>'
        ],
        'fonts' => [
                'heading' => '<string>',
                'body' => '<string>'
        ],
        'customCssUrl' => '<string>',
        'customCssInline' => '<string>'
    ],
    'navigation' => [
        'version' => 123,
        'homePage' => '<string>',
        'menu' => [
                [
                                'id' => '<string>',
                                'label' => '<string>',
                                'icon' => '<string>',
                                'color' => '<string>',
                                'href' => '<string>',
                                'expanded' => true,
                                'badge' => '<string>',
                                'permissions' => [
                                                                '<string>'
                                ],
                                'features' => [
                                                                [
                                                                                                                                'slug' => '<string>',
                                                                                                                                'label' => '<string>',
                                                                                                                                'agentId' => '<string>',
                                                                                                                                'templateId' => '<string>',
                                                                                                                                'permissions' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ]
                                ],
                                'visibility' => [
                                                                'tiers' => [
                                                                                                                                '<string>'
                                                                ],
                                                                'features' => [
                                                                                                                                '<string>'
                                                                ]
                                ],
                                'items' => '<array>'
                ]
        ],
        'footer' => [
                [
                                'id' => '<string>',
                                'label' => '<string>',
                                'icon' => '<string>',
                                'color' => '<string>',
                                'href' => '<string>',
                                'expanded' => true,
                                'badge' => '<string>',
                                'permissions' => [
                                                                '<string>'
                                ],
                                'features' => [
                                                                [
                                                                                                                                'slug' => '<string>',
                                                                                                                                'label' => '<string>',
                                                                                                                                'agentId' => '<string>',
                                                                                                                                'templateId' => '<string>',
                                                                                                                                'permissions' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ]
                                ],
                                'visibility' => [
                                                                'tiers' => [
                                                                                                                                '<string>'
                                                                ],
                                                                'features' => [
                                                                                                                                '<string>'
                                                                ]
                                ],
                                'items' => '<array>'
                ]
        ],
        'quickActions' => [
                [
                                'id' => '<string>',
                                'label' => '<string>',
                                'icon' => '<string>',
                                'color' => '<string>',
                                'href' => '<string>',
                                'expanded' => true,
                                'badge' => '<string>',
                                'permissions' => [
                                                                '<string>'
                                ],
                                'features' => [
                                                                [
                                                                                                                                'slug' => '<string>',
                                                                                                                                'label' => '<string>',
                                                                                                                                'agentId' => '<string>',
                                                                                                                                'templateId' => '<string>',
                                                                                                                                'permissions' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ]
                                ],
                                'visibility' => [
                                                                'tiers' => [
                                                                                                                                '<string>'
                                                                ],
                                                                'features' => [
                                                                                                                                '<string>'
                                                                ]
                                ],
                                'items' => '<array>'
                ]
        ]
    ],
    'joinRules' => [
        [
                'rules' => [
                                [
                                                                'field' => '<string>',
                                                                'value' => '<string>'
                                ]
                ],
                'role' => '<string>',
                'groups' => [
                                '<string>'
                ]
        ]
    ],
    'defaultRole' => '<string>',
    'settings' => [
        
    ],
    'subscriptionSlug' => '<string>',
    'createdBy' => '<string>',
    'updatedBy' => '<string>',
    'createdAt' => '<string>',
    'updatedAt' => '<string>'
  ]),
  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://api.eda.prisme.ai/v2/orgs/{orgSlug}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"photo\": \"<string>\",\n  \"domains\": [\n    \"<string>\"\n  ],\n  \"branding\": {\n    \"version\": \"<string>\",\n    \"platformName\": \"<string>\",\n    \"description\": \"<string>\",\n    \"logo\": {\n      \"light\": \"<string>\",\n      \"dark\": \"<string>\"\n    },\n    \"favicon\": \"<string>\",\n    \"colors\": {\n      \"primary\": \"<string>\",\n      \"secondary\": \"<string>\",\n      \"accent\": \"<string>\"\n    },\n    \"fonts\": {\n      \"heading\": \"<string>\",\n      \"body\": \"<string>\"\n    },\n    \"customCssUrl\": \"<string>\",\n    \"customCssInline\": \"<string>\"\n  },\n  \"navigation\": {\n    \"version\": 123,\n    \"homePage\": \"<string>\",\n    \"menu\": [\n      {\n        \"id\": \"<string>\",\n        \"label\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"color\": \"<string>\",\n        \"href\": \"<string>\",\n        \"expanded\": true,\n        \"badge\": \"<string>\",\n        \"permissions\": [\n          \"<string>\"\n        ],\n        \"features\": [\n          {\n            \"slug\": \"<string>\",\n            \"label\": \"<string>\",\n            \"agentId\": \"<string>\",\n            \"templateId\": \"<string>\",\n            \"permissions\": [\n              \"<string>\"\n            ]\n          }\n        ],\n        \"visibility\": {\n          \"tiers\": [\n            \"<string>\"\n          ],\n          \"features\": [\n            \"<string>\"\n          ]\n        },\n        \"items\": \"<array>\"\n      }\n    ],\n    \"footer\": [\n      {\n        \"id\": \"<string>\",\n        \"label\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"color\": \"<string>\",\n        \"href\": \"<string>\",\n        \"expanded\": true,\n        \"badge\": \"<string>\",\n        \"permissions\": [\n          \"<string>\"\n        ],\n        \"features\": [\n          {\n            \"slug\": \"<string>\",\n            \"label\": \"<string>\",\n            \"agentId\": \"<string>\",\n            \"templateId\": \"<string>\",\n            \"permissions\": [\n              \"<string>\"\n            ]\n          }\n        ],\n        \"visibility\": {\n          \"tiers\": [\n            \"<string>\"\n          ],\n          \"features\": [\n            \"<string>\"\n          ]\n        },\n        \"items\": \"<array>\"\n      }\n    ],\n    \"quickActions\": [\n      {\n        \"id\": \"<string>\",\n        \"label\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"color\": \"<string>\",\n        \"href\": \"<string>\",\n        \"expanded\": true,\n        \"badge\": \"<string>\",\n        \"permissions\": [\n          \"<string>\"\n        ],\n        \"features\": [\n          {\n            \"slug\": \"<string>\",\n            \"label\": \"<string>\",\n            \"agentId\": \"<string>\",\n            \"templateId\": \"<string>\",\n            \"permissions\": [\n              \"<string>\"\n            ]\n          }\n        ],\n        \"visibility\": {\n          \"tiers\": [\n            \"<string>\"\n          ],\n          \"features\": [\n            \"<string>\"\n          ]\n        },\n        \"items\": \"<array>\"\n      }\n    ]\n  },\n  \"joinRules\": [\n    {\n      \"rules\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"role\": \"<string>\",\n      \"groups\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"defaultRole\": \"<string>\",\n  \"settings\": {},\n  \"subscriptionSlug\": \"<string>\",\n  \"createdBy\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"updatedAt\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.eda.prisme.ai/v2/orgs/{orgSlug}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"photo\": \"<string>\",\n  \"domains\": [\n    \"<string>\"\n  ],\n  \"branding\": {\n    \"version\": \"<string>\",\n    \"platformName\": \"<string>\",\n    \"description\": \"<string>\",\n    \"logo\": {\n      \"light\": \"<string>\",\n      \"dark\": \"<string>\"\n    },\n    \"favicon\": \"<string>\",\n    \"colors\": {\n      \"primary\": \"<string>\",\n      \"secondary\": \"<string>\",\n      \"accent\": \"<string>\"\n    },\n    \"fonts\": {\n      \"heading\": \"<string>\",\n      \"body\": \"<string>\"\n    },\n    \"customCssUrl\": \"<string>\",\n    \"customCssInline\": \"<string>\"\n  },\n  \"navigation\": {\n    \"version\": 123,\n    \"homePage\": \"<string>\",\n    \"menu\": [\n      {\n        \"id\": \"<string>\",\n        \"label\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"color\": \"<string>\",\n        \"href\": \"<string>\",\n        \"expanded\": true,\n        \"badge\": \"<string>\",\n        \"permissions\": [\n          \"<string>\"\n        ],\n        \"features\": [\n          {\n            \"slug\": \"<string>\",\n            \"label\": \"<string>\",\n            \"agentId\": \"<string>\",\n            \"templateId\": \"<string>\",\n            \"permissions\": [\n              \"<string>\"\n            ]\n          }\n        ],\n        \"visibility\": {\n          \"tiers\": [\n            \"<string>\"\n          ],\n          \"features\": [\n            \"<string>\"\n          ]\n        },\n        \"items\": \"<array>\"\n      }\n    ],\n    \"footer\": [\n      {\n        \"id\": \"<string>\",\n        \"label\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"color\": \"<string>\",\n        \"href\": \"<string>\",\n        \"expanded\": true,\n        \"badge\": \"<string>\",\n        \"permissions\": [\n          \"<string>\"\n        ],\n        \"features\": [\n          {\n            \"slug\": \"<string>\",\n            \"label\": \"<string>\",\n            \"agentId\": \"<string>\",\n            \"templateId\": \"<string>\",\n            \"permissions\": [\n              \"<string>\"\n            ]\n          }\n        ],\n        \"visibility\": {\n          \"tiers\": [\n            \"<string>\"\n          ],\n          \"features\": [\n            \"<string>\"\n          ]\n        },\n        \"items\": \"<array>\"\n      }\n    ],\n    \"quickActions\": [\n      {\n        \"id\": \"<string>\",\n        \"label\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"color\": \"<string>\",\n        \"href\": \"<string>\",\n        \"expanded\": true,\n        \"badge\": \"<string>\",\n        \"permissions\": [\n          \"<string>\"\n        ],\n        \"features\": [\n          {\n            \"slug\": \"<string>\",\n            \"label\": \"<string>\",\n            \"agentId\": \"<string>\",\n            \"templateId\": \"<string>\",\n            \"permissions\": [\n              \"<string>\"\n            ]\n          }\n        ],\n        \"visibility\": {\n          \"tiers\": [\n            \"<string>\"\n          ],\n          \"features\": [\n            \"<string>\"\n          ]\n        },\n        \"items\": \"<array>\"\n      }\n    ]\n  },\n  \"joinRules\": [\n    {\n      \"rules\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"role\": \"<string>\",\n      \"groups\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"defaultRole\": \"<string>\",\n  \"settings\": {},\n  \"subscriptionSlug\": \"<string>\",\n  \"createdBy\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"updatedAt\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eda.prisme.ai/v2/orgs/{orgSlug}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"photo\": \"<string>\",\n  \"domains\": [\n    \"<string>\"\n  ],\n  \"branding\": {\n    \"version\": \"<string>\",\n    \"platformName\": \"<string>\",\n    \"description\": \"<string>\",\n    \"logo\": {\n      \"light\": \"<string>\",\n      \"dark\": \"<string>\"\n    },\n    \"favicon\": \"<string>\",\n    \"colors\": {\n      \"primary\": \"<string>\",\n      \"secondary\": \"<string>\",\n      \"accent\": \"<string>\"\n    },\n    \"fonts\": {\n      \"heading\": \"<string>\",\n      \"body\": \"<string>\"\n    },\n    \"customCssUrl\": \"<string>\",\n    \"customCssInline\": \"<string>\"\n  },\n  \"navigation\": {\n    \"version\": 123,\n    \"homePage\": \"<string>\",\n    \"menu\": [\n      {\n        \"id\": \"<string>\",\n        \"label\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"color\": \"<string>\",\n        \"href\": \"<string>\",\n        \"expanded\": true,\n        \"badge\": \"<string>\",\n        \"permissions\": [\n          \"<string>\"\n        ],\n        \"features\": [\n          {\n            \"slug\": \"<string>\",\n            \"label\": \"<string>\",\n            \"agentId\": \"<string>\",\n            \"templateId\": \"<string>\",\n            \"permissions\": [\n              \"<string>\"\n            ]\n          }\n        ],\n        \"visibility\": {\n          \"tiers\": [\n            \"<string>\"\n          ],\n          \"features\": [\n            \"<string>\"\n          ]\n        },\n        \"items\": \"<array>\"\n      }\n    ],\n    \"footer\": [\n      {\n        \"id\": \"<string>\",\n        \"label\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"color\": \"<string>\",\n        \"href\": \"<string>\",\n        \"expanded\": true,\n        \"badge\": \"<string>\",\n        \"permissions\": [\n          \"<string>\"\n        ],\n        \"features\": [\n          {\n            \"slug\": \"<string>\",\n            \"label\": \"<string>\",\n            \"agentId\": \"<string>\",\n            \"templateId\": \"<string>\",\n            \"permissions\": [\n              \"<string>\"\n            ]\n          }\n        ],\n        \"visibility\": {\n          \"tiers\": [\n            \"<string>\"\n          ],\n          \"features\": [\n            \"<string>\"\n          ]\n        },\n        \"items\": \"<array>\"\n      }\n    ],\n    \"quickActions\": [\n      {\n        \"id\": \"<string>\",\n        \"label\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"color\": \"<string>\",\n        \"href\": \"<string>\",\n        \"expanded\": true,\n        \"badge\": \"<string>\",\n        \"permissions\": [\n          \"<string>\"\n        ],\n        \"features\": [\n          {\n            \"slug\": \"<string>\",\n            \"label\": \"<string>\",\n            \"agentId\": \"<string>\",\n            \"templateId\": \"<string>\",\n            \"permissions\": [\n              \"<string>\"\n            ]\n          }\n        ],\n        \"visibility\": {\n          \"tiers\": [\n            \"<string>\"\n          ],\n          \"features\": [\n            \"<string>\"\n          ]\n        },\n        \"items\": \"<array>\"\n      }\n    ]\n  },\n  \"joinRules\": [\n    {\n      \"rules\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"role\": \"<string>\",\n      \"groups\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"defaultRole\": \"<string>\",\n  \"settings\": {},\n  \"subscriptionSlug\": \"<string>\",\n  \"createdBy\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"updatedAt\": \"<string>\"\n}"

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

200

{
  "name": "<string>",
  "slug": "<string>",
  "id": "<string>",
  "description": "<string>",
  "photo": "<string>",
  "domains": [
    "<string>"
  ],
  "branding": {
    "version": "<string>",
    "platformName": "<string>",
    "description": "<string>",
    "logo": {
      "light": "<string>",
      "dark": "<string>"
    },
    "favicon": "<string>",
    "colors": {
      "primary": "<string>",
      "secondary": "<string>",
      "accent": "<string>"
    },
    "fonts": {
      "heading": "<string>",
      "body": "<string>"
    },
    "customCssUrl": "<string>",
    "customCssInline": "<string>"
  },
  "navigation": {
    "version": 123,
    "homePage": "<string>",
    "menu": [
      {
        "id": "<string>",
        "label": "<string>",
        "icon": "<string>",
        "color": "<string>",
        "href": "<string>",
        "expanded": true,
        "badge": "<string>",
        "permissions": [
          "<string>"
        ],
        "features": [
          {
            "slug": "<string>",
            "label": "<string>",
            "agentId": "<string>",
            "templateId": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "visibility": {
          "tiers": [
            "<string>"
          ],
          "features": [
            "<string>"
          ]
        },
        "items": "<array>"
      }
    ],
    "footer": [
      {
        "id": "<string>",
        "label": "<string>",
        "icon": "<string>",
        "color": "<string>",
        "href": "<string>",
        "expanded": true,
        "badge": "<string>",
        "permissions": [
          "<string>"
        ],
        "features": [
          {
            "slug": "<string>",
            "label": "<string>",
            "agentId": "<string>",
            "templateId": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "visibility": {
          "tiers": [
            "<string>"
          ],
          "features": [
            "<string>"
          ]
        },
        "items": "<array>"
      }
    ],
    "quickActions": [
      {
        "id": "<string>",
        "label": "<string>",
        "icon": "<string>",
        "color": "<string>",
        "href": "<string>",
        "expanded": true,
        "badge": "<string>",
        "permissions": [
          "<string>"
        ],
        "features": [
          {
            "slug": "<string>",
            "label": "<string>",
            "agentId": "<string>",
            "templateId": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "visibility": {
          "tiers": [
            "<string>"
          ],
          "features": [
            "<string>"
          ]
        },
        "items": "<array>"
      }
    ]
  },
  "joinRules": [
    {
      "rules": [
        {
          "field": "<string>",
          "value": "<string>"
        }
      ],
      "role": "<string>",
      "groups": [
        "<string>"
      ]
    }
  ],
  "defaultRole": "<string>",
  "settings": {},
  "subscriptionSlug": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

Authorizations

BearerAuthWorkspaceApiKeyAuthBearerAuth & WorkspaceApiKeyAuth

Authorization · string · header · required

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

Path Parameters

orgSlug · string · required

Body

application/json

name · string · required

slug · string · required

id · string

description · string

photo · string

status · enum<string>

Available options: active, suspended

domains · string[]

branding · object

Show child attributes

navigation · object

Organization navigation configuration

Show child attributes

joinRules · object[]

Auto-join rules. Each item is an OR case with AND-chained conditions in rules[]. Example: [{ rules: [{ field: "email", operator: "endsWith", value: "@acme.com" }], role: "member", groups: ["engineering"] }]

Show child attributes

defaultRole · string

settings · object

subscriptionSlug · string

createdBy · string

updatedBy · string

createdAt · string

updatedAt · string

Response

200

application/json

Success

name · string · required

slug · string · required

id · string

description · string

photo · string

status · enum<string>

Available options: active, suspended

domains · string[]

branding · object

Show child attributes

navigation · object

Organization navigation configuration

Show child attributes

joinRules · object[]

Auto-join rules. Each item is an OR case with AND-chained conditions in rules[]. Example: [{ rules: [{ field: "email", operator: "endsWith", value: "@acme.com" }], role: "member", groups: ["engineering"] }]

Show child attributes

defaultRole · string

settings · object

subscriptionSlug · string

createdBy · string

updatedBy · string

createdAt · string

updatedAt · string