company-profile

Update the workspace company profile

Partial update of company-profile fields (only provided fields are written).

patch/v1/company-profile

Request

  • Base URL: https://api.patricia.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.patricia.app/v1/company-profile
  • Auth: HTTP bearer

Headers

X-Tenant-Idstring nullable

Request body

website_urlstring nullable

The company website URL.

brand_namestring nullable

The company or brand name.

target_audiencestring nullable

The people the company serves.

what_you_dostring nullable

What the company does.

differentiationstring nullable

What distinguishes the company.

tone_of_voicestring nullable

How the company speaks in its content.

voice_warmthstring nullable
voice_formalitystring nullable
voice_lengthstring nullable
voice_technical_depthstring nullable
voice_emojiboolean nullable
sellsstring[] nullable
growth_channelsstring[] nullable

The channels the company grows through.

market_sizestring nullable

How big the company is, in its own words.

market_business_modelstring nullable

b2b, b2c or both.

market_competitorsstring[] nullable

The competitors the company names.

brand_colorsstring[] nullable
color_rolesobject nullable
chart_palettestring[] nullable
chart_palettesobject nullable
voice_traitsstring[] nullable
add_onsobject nullable

Response

Successful Response

website_urlstring nullable
brand_namestring nullable
target_audiencestring nullable
what_you_dostring nullable
differentiationstring nullable
tone_of_voicestring nullable
voice_warmthstring nullable
voice_formalitystring nullable
voice_lengthstring nullable
voice_technical_depthstring nullable
voice_emojiboolean nullable
sellsstring[]
brand_colorsstring[]
logo_urlstring nullable
analyzed_atstring date-time nullable
onboarding_completedboolean
color_rolesobject
chart_palettestring[]
chart_palettesobject
typographyobject
add_onsobject
themeobject nullable
brand_rulesobject
voice_traitsstring[]
brand_wordsobject
field_statesobject
brand_kit_versioninteger

Changes

No recorded changes to this operation across all 1 revision of this API.