AccountCustomer portal

Publish the customer portal draft

POST
/v1/account/portal/publish

Copies the customer-portal builder’s draft onto your live portal, whole: every field the draft holds, including the ones it holds at their default, replaces the matching field on the live document. Customers see the result at once. Live and sandbox publish their own draft, independently.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Response Body

Success

application/json
  1. response

Success

portal*

How your customer portal and storefront look, and what your customers may do there

portalDraft*

The portal builder’s own draft: what Publish will copy onto your live portal. Edited by PATCH /account/portal/draft, and only ever reaches customers once you publish it

curl -X POST "https://example.com/v1/account/portal/publish"
{  "portal": {    "enabled": true,    "brandName": "Northwind",    "logoUrl": "https://northwind.example/logo.svg",    "logoDarkUrl": "https://northwind.example/logo-white.svg",    "accentColor": "#1d4ed8",    "supportEmail": "[email protected]",    "emailFromName": "Northwind Support",    "termsUrl": "https://northwind.example/terms",    "privacyUrl": "https://northwind.example/privacy",    "selfSignup": true,    "allow": [      "domains.nameservers"    ],    "products": [      "domains"    ],    "theme": "light",    "fontPair": "geist",    "headline": "Find your domain",    "intro": "Search a name across every ending we sell.",    "banner": "string",    "productOrder": [      "domains"    ],    "termsMode": "link",    "termsText": "string",    "privacyMode": "link",    "privacyText": "string",    "faq": [      {        "question": "string",        "answer": "string"      }    ],    "pricesBeforeSignIn": true,    "requireEmailVerification": true,    "url": "https://northwind.portal.example",    "publishedAt": null  },  "portalDraft": {    "enabled": true,    "brandName": "Northwind",    "logoUrl": "https://northwind.example/logo.svg",    "logoDarkUrl": "https://northwind.example/logo-white.svg",    "accentColor": "#1d4ed8",    "supportEmail": "[email protected]",    "emailFromName": "Northwind Support",    "termsUrl": "https://northwind.example/terms",    "privacyUrl": "https://northwind.example/privacy",    "selfSignup": true,    "allow": [      "domains.nameservers"    ],    "products": [      "domains"    ],    "theme": "light",    "fontPair": "geist",    "headline": "Find your domain",    "intro": "Search a name across every ending we sell.",    "banner": "string",    "productOrder": [      "domains"    ],    "termsMode": "link",    "termsText": "string",    "privacyMode": "link",    "privacyText": "string",    "faq": [      {        "question": "string",        "answer": "string"      }    ],    "pricesBeforeSignIn": true,    "requireEmailVerification": true  }}