Sign UpSupported Devices
Edit

Create a Workspace

Creates a new workspace.

Creates a new sandbox workspace.

Code:

await seam.workspaces.create({
  name: "My Sandbox Workspace",
  company_name: "Acme",
  connect_partner_name: "Acme",
  is_sandbox: true,
  is_publishable_key_auth_enabled: true,
  publishable_key: "seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE",
  webview_primary_button_color: "#232426",
  webview_primary_button_text_color: "#FFFDE7",
  webview_logo_shape: "circle",
  webview_success_message:
    "Your account has been successfully connected to 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!",
  },
});

Output:

Authentication Methods

  • Personal access token Must omit the seam-workspace header from the request.

To learn more, see Authentication.

Request Parameters

name String (Required)

Name of the new workspace.

company_name String

Company name for the new workspace.

connect_partner_name String

Connect partner name for the new workspace.

Deprecated. Use company_name instead.

connect_webview_customization Object

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

logo_shape Enum

Logo shape for Connect Webviews in the new 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 new 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 new workspace. See also Customize the Look and Feel of Your Connect Webviews.

success_message String

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

is_sandbox Boolean

Indicates whether the new workspace is a sandbox workspace.

webview_logo_shape String

Deprecated. Use connect_webview_customization.webview_logo_shape instead.

webview_primary_button_color String

Deprecated. Use connect_webview_customization.webview_primary_button_color instead.

webview_primary_button_text_color String

Deprecated. Use connect_webview_customization.webview_primary_button_text_color instead.

webview_success_message String

Deprecated. Use connect_webview_customization.webview_success_message instead.

Response

Returns: workspace

Examples

Create a production workspace

Creates a new production workspace.

Code:

Output:

PreviousWorkspacesNextGet a Workspace

Last updated

Was this helpful?