RErebrandly
Workspaces

Create Workspace

Create a new workspace.

Feature Flags:

  • links.expiration: Required if expiration.ttl provided
  • links.extended: Required if type is "extended"
post/workspaces

Request

  • Base URL
    https://api.rebrandly.com/v1
  • URL
    https://api.rebrandly.com/v1/workspaces
  • Auth
    API key in header apikey

Headers

apikeystring required

API key for authentication

Request body

namestring required

Workspace name

type'classic' | 'extended' | 'gallery'
notesstring

Workspace description

avatarUrlstring uri

Workspace avatar URL

Response

Workspace created

idstring required

Workspace public ID

namestring required

Workspace name

avatarUrlstring

Workspace avatar URL

linksinteger

Number of links in workspace

teammatesinteger

Number of teammates in workspace

domainsinteger

Number of domains in workspace

createdAtstring date-time required
updatedAtstring date-time
type'classic' | 'extended' | 'gallery' required
defaultboolean
revokedboolean
role'owner' | 'admin' | 'user' | 'guest' | 'viewer'
clicksinteger
sessionsinteger

Example response

{
  "id": "workspace123abc",
  "name": "My Workspace",
  "conversionTracking": {
    "enabled": true,
    "attributionWindow": 30,
    "apiKeyCreatedByOwner": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.