Skip to main content
PUT
/
v1
/
workspaces
/
{id}
Editar workspace
curl --request PUT \
  --url https://api.notifique.dev/v1/workspaces/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Workspace Renomeado",
  "color": "#10B981",
  "defaultInstanceId": "clzz...",
  "defaultEmailDomainId": null,
  "groupFeaturesEnabled": false,
  "inboundSettingsPatch": {
    "channels": {
      "sms": {
        "enabled": true
      },
      "whatsapp": {
        "enabled": true,
        "allowPrivateChats": true,
        "allowGroupChats": false
      }
    }
  }
}
'
{
  "success": true,
  "data": {
    "id": "clxx...",
    "name": "Workspace Renomeado",
    "slug": "meu-workspace-123",
    "color": "#10B981",
    "defaultInstanceId": "clzz...",
    "defaultEmailDomainId": null,
    "groupFeaturesEnabled": false,
    "inboundSettings": {
      "version": 1,
      "channels": {
        "sms": {
          "enabled": true
        },
        "whatsapp": {
          "enabled": true,
          "allowPrivateChats": true,
          "allowGroupChats": false
        },
        "email": {
          "enabled": true
        }
      }
    },
    "updatedAt": "2025-02-23T10:30:00.000Z"
  }
}

Authorizations

Authorization
string
header
required

API Key: Authorization: Bearer sk_live_xxxxx

Path Parameters

id
string
required

ID do workspace (deve ser o workspace da API Key).

Body

application/json
name
string
Maximum string length: 64
color
string | null

Cor em hexadecimal com # (ex.: #3B82F6); null para limpar.

Required string length: 7
Pattern: ^#[0-9A-Fa-f]{6}$
defaultInstanceId
string | null

ID da instância WhatsApp padrão; null para limpar.

defaultEmailDomainId
string | null

ID do domínio de e-mail padrão; null para limpar.

groupFeaturesEnabled
boolean

Ativa recursos experimentais de grupos WhatsApp (listar grupos, add/remove participante, convite). Documentação em OpenAPI separado (oculto por padrão).

inboundSettingsPatch
object

Merge parcial com a política atual de inbound: apenas campos enviados são atualizados; omitidos permanecem como estão.

Response

Workspace atualizado.

success
boolean
required
Example:

true

data
object
required