Reach: Profiles

Get profile settings

Changed on

Get the profile's saved sender identity and brand details.

Read the default sender before creating a campaign instead of asking the customer, and reuse the brand fields when generating email content. Any field can be null for a profile that never filled its settings in. This does not check that the sending domain is verified, use the connected sending domain endpoint for that.

get/api/reach/v1/profiles/{profileUuid}/settings

Request

  • Base URL: https://developers.hostinger.com
  • URL: https://developers.hostinger.com/api/reach/v1/profiles/{profileUuid}/settings
  • Auth: HTTP bearer

Path parameters

profileUuidstring required
Example:550e8400-e09b-41d4-a716-400055000000

Profile uuid parameter

Response

Success response

brand_namestring nullable
website_urlstring nullable
business_addressstring nullable
privacy_policy_urlstring nullable
accent_colorstring nullable
button_colorstring nullable
background_colorstring nullable
text_colorstring nullable
links_colorstring nullable
button_textstring nullable

Button text colour.

button_cornersinteger nullable

Button corner radius in pixels.

font_familystring nullable

Body and button font.

heading_font_familystring nullable
logo_urlstring nullable
social_linksstring[] nullable
socialsobject nullable

Social profile links keyed by platform.

aboutstring nullable
keywordsstring[] nullable
topicsstring[] nullable
selling_pointsstring[] nullable
sender_namestring nullable

Default sender name that campaigns created afterwards start from.

sender_emailstring nullable

Part of the default sender address before the @. It is combined with the profile's connected sending domain, see the connected sending domain endpoint.

Example response

{
  "brand_name": "Acme Corporation",
  "website_url": "https://example.com",
  "business_address": "123 Main St, New York, NY 10001",
  "privacy_policy_url": "https://example.com/privacy",
  "accent_color": "#FF0000",
  "button_color": "#00FF00",
  "background_color": "#FFFFFF",
  "text_color": "#000000",
  "links_color": "#0000FF",
  "button_text": "#FFFFFF",
  "button_corners": 8,
  "font_family": "Arial",
  "heading_font_family": "Poppins",
  "logo_url": "https://example.com/logo.png",
  "social_links": [
    "https://facebook.com/example"
  ],
  "about": "We provide innovative solutions.",
  "sender_name": "Acme",
  "sender_email": "hello"
}

Changes