Skip to main content
POST
/
api
/
workspaces.update
Update an existing workspace
curl --request POST \
  --url https://your-instance.example.com/api/workspaces.update \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "status": "initializing",
  "name": "<string>",
  "website": "<string>",
  "timezone": "<string>",
  "currency": "<string>",
  "logo_url": "<string>",
  "settings": {
    "timescore_reference": 2,
    "bounce_threshold": 2,
    "custom_dimensions": {},
    "filters": [
      {}
    ],
    "integrations": [
      {}
    ],
    "geo_enabled": true,
    "geo_store_city": true,
    "geo_store_region": true,
    "geo_coordinates_precision": 1,
    "annotations": [
      {
        "id": "<string>",
        "date": "<string>",
        "time": "<string>",
        "timezone": "<string>",
        "title": "<string>",
        "description": "<string>",
        "color": "<string>"
      }
    ],
    "smtp": {
      "enabled": true,
      "host": "<string>",
      "port": 32768,
      "from_name": "<string>",
      "from_email": "[email protected]",
      "username": "<string>",
      "password_encrypted": "<string>"
    },
    "allowed_domains": [
      "<string>"
    ]
  }
}
'
{}

Body

application/json
id
string
required
status
enum<string>
Available options:
initializing,
active,
inactive,
error
name
string
website
string<uri>
timezone
string
currency
string
logo_url
string<uri>
settings
object

Response

201 - application/json

The response is of type object.