Skip to navigation
HeyReach APIVoice

GetSenderVoice

View as Markdown

Get the voice assigned to a sender (LinkedIn account).

Errors

  • 403 NO_ACTIVE_SUBSCRIPTION or VOICE_NOTES_NOT_ENABLED.
  • 404 LINKEDIN_ACCOUNT_NOT_FOUND: the account is not in the workspace (checked first, for an unknown and another workspace’s account alike). SENDER_VOICE_NOT_ASSIGNED: the account has no voice assigned.

Path parameters

accountIdintegerRequired

Headers

X-API-KEYstringOptional

API key header using this scheme. Example: “X-API-KEY: {API_KEY}”

Response

OK
accountIdinteger
voiceIdinteger
kindenum
Allowed values:
namestring
statusenum
Allowed values:
usedInActiveCampaignsboolean
providerenum
Allowed values:
unavailableReasonstring or nullOptional

Non-null for an ElevenLabs voice that cannot be used right now (same values as the GetVoices unavailableReason); this sender’s voice steps then send the fallback text.

availableUntildatetime or nullOptional

UTC. Set only for an ElevenLabs Voice Library voice whose owner removed it from the ElevenLabs Voice Library: the date ElevenLabs stops serving it. The voice keeps working until then; assign another voice before that date. Null for every other voice. As of the last library sync: about once a day automatically while a sender in the workspace uses an ElevenLabs voice, or at once with RefreshElevenLabsLibrary. When unavailableReason is also set, the voice is already unusable and unavailableReason applies.

Errors

403
Get Sender Voice Voice Request Forbidden Error
404
Get Sender Voice Voice Request Not Found Error