Set the custom portal domain
Returns the CNAME and TXT records you must create. Only a business on Enterprise or with the custom portal domain add-on can use one.
Your API key, which acts for the one business it was created for: fb_sandbox_… issues in sandbox, fb_test_… in test, the tax authority's testing service, and fb_live_… in live.
In: header
Path Parameters
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A subdomain whose DNS you control. Root domains are not accepted.
1 <= length <= 253Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X PUT "https://example.com/v1/ec/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/portal-domain" \ -H "Content-Type: application/json" \ -d '{ "hostname": "string" }'{ "object": "portal_domain", "entity_id": "8161163a-f227-466f-bc01-090a01e80165", "hostname": "string", "status": "pending", "portal_url": "http://example.com", "dns_records": [ { "type": "CNAME", "name": "string", "value": "string" } ], "failure_code": "dns_not_pointing", "failure_reason": "string", "last_checked_at": "2019-08-24T14:15:22Z", "verified_at": "2019-08-24T14:15:22Z"}Get the custom portal domain GET
The domain with its status, the portal address in use today and the two DNS records it needs. It only reads: it doesn't check the DNS at that moment.
Remove the custom portal domain DELETE
The portal stops answering on that domain right away and new links use `portal.fiscalbase.io/{entity_id}`; the registration with the edge provider is withdrawn afterwards. Links already sent to your customers with the custom domain stop working. To use it again, set it up again.