White-label

Update White-label Config

Changed on

Update one or more branding fields. Hex colours validated as #RRGGBB; custom_domain validated as RFC-1035 subdomain. Setting custom_domain resets domain_verified=false; call /whitelabel/domain/verify after pointing your CNAME to api.astroway.info.

patch/whitelabel/config

Request

  • Base URL: https://api.astroway.info/v1
  • URL: https://api.astroway.info/v1/whitelabel/config
  • Auth: API key in header X-Api-Key

Query parameters

fieldsstring

Comma-separated dotted paths, relative to data, to keep in the response. A path is applied to every element of an array, so planets.name means the name of each planet. Paths that match nothing come back in _fields_unmatched; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer.

precisioninteger

Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute.

Request body

primaryColorstring
secondaryColorstring
fontFamilystring
footerTextstring nullable
customDomainstring nullable
companyNamestring nullable
companyUrlstring uri nullable
companyEmailstring email nullable
companyMobilestring nullable
companyBiostring nullable
reportNamestring nullable

Response

Successful calculation

okboolean

Example response

{
  "ok": true
}

Changes

  • e9234ffdb4f0Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • b64222844186Revision changes
    • info

      added the new optional query request parameter fields

    • info

      added the new optional query request parameter precision