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

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

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.

Example:

"idem-1"

Body

application/json
portalBaseUrl
string<uri>
required

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://[^/?#@]+([/?][^#]*)?$
Example:

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

Response

OK

portalBaseUrl
string<uri>
required

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://[^/?#@]+([/?][^#]*)?$
Example:

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