Account

Change the writer's profile.

A writer's profile: their name and location, their public portfolio page (publicProfileEnabled, its URL publicSlug, publicHeadline, website, IMDb and Instagram links, up to 12 featuredScriptIds) and the discovery details (summary, specialties, genres, formats, accolades, credits, availability, how to reach them). An update changes only the fields it sends; an empty string clears a text field. Turning the page public screens what it would show first, and a URL another page holds is refused. Free. Answers the profile as it now reads. A URL another page holds, a reserved URL, or a featured script the writer does not own is refused validation_failed with details.field. Naturally idempotent. Scope: account:write.

patch/account/profile

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/account/profile
  • Auth: HTTP bearer

Request body

namestring
locationstring
publicProfileEnabledboolean

Turn the public page on (what it would show is screened first) or off.

publicSlugstring

The public page's URL; made URL-safe, refused when reserved or taken.

publicHeadlinestring
featuredScriptIdsstring[]

Scripts (their ids) the public page features, in order; each must be the writer's own.

discoverySummarystring
discoverySpecialtiesstring[]
discoveryGenresstring[]
discoveryFormatsstring[]
discoveryAccoladesstring[]
discoveryCreditsstring[]
discoveryAvailabilitystring
discoveryContactPreferencestring

Response

The profile as it now reads.

Changes

No recorded changes to this operation across all 2 revisions of this API.