Workspace <> Organization

workspaceId deprecation: what changes and how to migrate to organizationId

Summary

The workspaceId identifier was renamed to organizationId across the whole V4MOS.AI API. The value is exactly the same, only the field name changes. Every call that still sends workspaceId now returns HTTP 400 with the code WORKSPACE_ID_DEPRECATED.

Why are we making this change?

We are unifying the identity of the V4 platform. Previously each product had its own concept of "workspace"; now everything revolves around the organization, the central concept of the new identity shared by all V4 products.

In practice, the identifier you already used keeps the same value — only the field name changed to match the new standard.

What exactly changes?

BeforeAfter
workspaceId field (camelCase)organizationId
workspace_id field (snake_case, in responses)organization_id

This page covers the public API documented on this site. Every public endpoint is a GET query, so the change shows up only in the query parameter and in response fields: no public endpoint had its path changed or takes workspaceId in a request body. Internal routes used only by the V4MOS.AI platform are not part of this API.

What does not change:

  • The values stay exactly the same. If your workspaceId was abc-123, the new organizationId is also abc-123.
  • Authentication, headers and the other API contracts are unchanged.

When does it take effect?

The change is a big bang, with no backward compatibility. At the deploy agreed with the product teams, the API starts rejecting any call that still sends workspaceId.

What you need to do

1. Replace workspaceId with organizationId in query strings

Before:

GET /v1/google/accounts?workspaceId=abc-123

After:

GET /v1/google/accounts?organizationId=abc-123

2. Update how you read responses

Before:

{
  "customer_id": "12345",
  "workspace_id": "abc-123",
  "integration_name": "google_ads"
}

After:

{
  "customer_id": "12345",
  "organization_id": "abc-123",
  "integration_name": "google_ads"
}

How do I know my integration is already updated?

While any call from your integration still sends workspaceId, the API rejects the request with HTTP 400 and returns:

{
  "code": "WORKSPACE_ID_DEPRECATED",
  "message": "O parâmetro \"workspaceId\" foi descontinuado. Com a unificação do identity do produto, o workspace agora é representado pelo \"organizationId\" (mesmo valor, novo nome). Consulte https://developers.v4mos.ai/pt/essentials/workspace-organization/ para detalhes e instruções de migração."
}

This error is the fastest way to find the places in your code that still need updating — just monitor occurrences of the WORKSPACE_ID_DEPRECATED code in your environment.

Once all your calls are migrated, you stop receiving this error and everything works normally again.

Migration checklist

Before considering your integration migrated, check that:

  • Every ?workspaceId= query param was replaced with ?organizationId=
  • Any code that read response.workspace_id now reads response.organization_id
  • Your automated tests pass against the new API version
  • You no longer get the WORKSPACE_ID_DEPRECATED error in any environment

Questions?

If something is unclear or you hit unexpected behavior during the migration, open a ticket with the V4MOS.AI API team or reach out through the official developer support channels.

On this page