User

post/user

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/user
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Request body

first_namestring nullable
last_namestring nullable
image_urlstring nullable
plan_typestring nullable
is_verifiedboolean nullable
last_seen_tsnumber nullable
timezone_offset_minutesnumber nullable
settingsobject

Response

user_guidstring required
uuidstring required
first_namestring nullable
last_namestring nullable
image_urlstring required
created_bystring nullable
rolestring nullable
created_tsnumber required
last_updated_tsnumber required
last_seen_tsnumber required
timezone_offset_minutesnumber required
is_verifiedstring required
is_allowed_through_gateboolean required
phone_txtstring nullable
email_txtstring nullable
workspace_guidsstring[] required
settingsobject required
last_seen_onstring date-time nullable
plan_typestring required
languagesstring[] required
voice_gender'F' | 'M'
voice_idstring nullable
has_fcm_tokenboolean required
tts_mode'cloned_voice' | 'standard' | 'premium' required
translation_mode'not_specified' | 'none' | 'tts' | 'dubbing' required
preserve_senders_voiceboolean required
user_type'user' | 'bot' | 'agent' required
is_agentboolean required
owner_idstring nullable required

Changes

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