Skip to main content

PersonaUpdateRequest

avatar_prompt object
anyOf
string
avatar_source object
anyOf
string
avatar_url object
anyOf
string
category object
anyOf
string
communication_style object
anyOf
string
concerns object
anyOf
string
description object
anyOf
string
entity_kind object
anyOf
string
external_sources object
anyOf
  • Array [
  • property name*any
  • ]
  • include_in_audience object
    anyOf
    boolean
    include_in_voice_list object
    anyOf
    boolean
    instructions object
    anyOf
    string
    interests object
    anyOf
    string
    is_active object
    anyOf
    boolean
    labels object
    anyOf
  • Array [
  • string
  • ]
  • linked_knowledgebase_ids object
    anyOf
  • Array [
  • string
  • ]
  • name object
    anyOf
    string
    response_language object
    anyOf
    string
    social_links object
    anyOf
  • Array [
  • platformPlatformrequired
    Example: linkedin
    urlUrlrequired
    Example: https://www.linkedin.com/in/example
    property name*any
  • ]
  • template object
    anyOf
    string
    tone object
    anyOf
    string
    voice_perspective object
    anyOf
    string
    voice_profile object

    Replace the default voice profile.

    anyOf
    property name*any
    voice_visibility object

    workspace or private.

    anyOf
    string
    writing_sample_document_ids object
    anyOf
  • Array [
  • string
  • ]
  • property name*any
    PersonaUpdateRequest
    {
    "avatar_prompt": "string",
    "avatar_source": "string",
    "avatar_url": "string",
    "category": "string",
    "communication_style": "string",
    "concerns": "string",
    "description": "string",
    "entity_kind": "string",
    "external_sources": [
    {}
    ],
    "include_in_audience": true,
    "include_in_voice_list": true,
    "instructions": "string",
    "interests": "string",
    "is_active": true,
    "labels": [
    "string"
    ],
    "linked_knowledgebase_ids": [
    "string"
    ],
    "name": "string",
    "response_language": "string",
    "social_links": [
    {
    "platform": "linkedin",
    "url": "https://www.linkedin.com/in/example"
    }
    ],
    "template": "string",
    "tone": "string",
    "voice_perspective": "string",
    "voice_profile": {},
    "voice_visibility": "string",
    "writing_sample_document_ids": [
    "string"
    ]
    }