Skip to main content
PUT
Set the tenant worker portal base URL

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string

Optional idempotency key. Sent again with the SAME body, the stored response is replayed and the URL is stored once; sent again with a DIFFERENT body, the request is refused with 422 because the key was already spent on another intent. Absent, the request executes once, exactly as it always has.

Exemplo:

"idem-1"

Corpo

application/json
portalBaseUrl
string<uri>
obrigatório

Base URL of the tenant's worker portal. Must use HTTPS, contain no credentials or fragment, and be at most 255 characters. When a tenant registers one, the gateway injects it as the type 0 contact of each bid proposal, unless that bid supplies its own portalBaseUrl override. Registering a portal is optional.

Maximum string length: 255
Pattern: ^https://[^/?#@]+([/?][^#]*)?$
Exemplo:

"https://portal.example.com/formalizacao"

Resposta

OK

portalBaseUrl
string<uri>
obrigatório

Base URL of the tenant's worker portal. Must use HTTPS, contain no credentials or fragment, and be at most 255 characters. When a tenant registers one, the gateway injects it as the type 0 contact of each bid proposal, unless that bid supplies its own portalBaseUrl override. Registering a portal is optional.

Maximum string length: 255
Pattern: ^https://[^/?#@]+([/?][^#]*)?$
Exemplo:

"https://portal.example.com/formalizacao"