Udpate a Workspace

• Request Parameters

• Response

Updates the workspace associated with the authentication value.

JavaScript

Updates the workspace associated with the authentication value.

Code:

await seam.workspaces.update({
  name: "My Workspace",
  connect_partner_name: "Acme",
  connect_webview_customization: {
    inviter_logo_url:
      "https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c",
    logo_shape: "circle",
    primary_button_color: "#232426",
    primary_button_text_color: "#FFFDE7",
    success_message: "Your account has been successfully connected to Acme!",
  },
  is_suspended: true,
});

Output:

// void

cURL

Updates the workspace associated with the authentication value.

Code:

curl --include --request POST "https://connect.getseam.com/workspaces/update" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "name": "My Workspace",
  "connect_partner_name": "Acme",
  "connect_webview_customization": {
    "inviter_logo_url": "https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c",
    "logo_shape": "circle",
    "primary_button_color": "#232426",
    "primary_button_text_color": "#FFFDE7",
    "success_message": "Your account has been successfully connected to Acme!"
  },
  "is_suspended": true
}
EOF

Output:

{}

Python

Updates the workspace associated with the authentication value.

Code:

seam.workspaces.update(
    name="My Workspace",
    connect_partner_name="Acme",
    connect_webview_customization={
        "inviter_logo_url": "https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c",
        "logo_shape": "circle",
        "primary_button_color": "#232426",
        "primary_button_text_color": "#FFFDE7",
        "success_message": "Your account has been successfully connected to Acme!",
    },
    is_suspended=true,
)

Output:

None

Ruby

Updates the workspace associated with the authentication value.

Code:

seam.workspaces.update(
  name: "My Workspace",
  connect_partner_name: "Acme",
  connect_webview_customization: {
    inviter_logo_url:
      "https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c",
    logo_shape: "circle",
    primary_button_color: "#232426",
    primary_button_text_color: "#FFFDE7",
    success_message: "Your account has been successfully connected to Acme!",
  },
  is_suspended: true,
)

Output:

nil

PHP

Updates the workspace associated with the authentication value.

Code:

$seam->workspaces->update(
    name: "My Workspace",
    connect_partner_name: "Acme",
    connect_webview_customization: [
        "inviter_logo_url" =>
            "https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c",
        "logo_shape" => "circle",
        "primary_button_color" => "#232426",
        "primary_button_text_color" => "#FFFDE7",
        "success_message" =>
            "Your account has been successfully connected to Acme!",
    ],
    is_suspended: true
);

Output:

Seam CLI

Updates the workspace associated with the authentication value.

Code:

seam workspaces update --name "My Workspace" --connect_partner_name "Acme" --connect_webview_customization {"inviter_logo_url":"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c","logo_shape":"circle","primary_button_color":"#232426","primary_button_text_color":"#FFFDE7","success_message":"Your account has been successfully connected to Acme!"} --is_suspended true

Output:

{}

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

connect_partner_name String

Connect partner name for the workspace.

---

connect_webview_customization Object

Connect Webview customizations for the workspace. See also Customize the Look and Feel of Your Connect Webviews.

logo_shape Enum

Logo shape for Connect Webviews in the workspace. See also Customize the Look and Feel of Your Connect Webviews.

Enum values:

• circle

• square

---

primary_button_color String

Primary button color for Connect Webviews in the workspace. See also Customize the Look and Feel of Your Connect Webviews.

---

primary_button_text_color String

Primary button text color for Connect Webviews in the workspace. See also Customize the Look and Feel of Your Connect Webviews.

---

success_message String

Success message for Connect Webviews in the workspace. See also Customize the Look and Feel of Your Connect Webviews.

---

is_suspended Boolean

Indicates whether the workspace is suspended.

---

name String

Name of the workspace.

---

Response

void