Create a voice phishing template

post

https://api.caniphish.com/api/v3/content-library/voice-phishing/create-voice-phishing-template

Creates a new voice phishing template; requires voice phishing to be active on the tenant. Rejects names already used by a custom template or a platform library template — to customise a platform template use update-voice-phishing-template, or copy it under a new name with duplicate-voice-phishing-template.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

tenantID

string

required

templateName

string

required

templateDescription

string

targetReqs

array of strings

Target data required to run this template. preLName and preJTitle are accepted even though the current console form has those two options commented out (not currently offered to end users, but honored if supplied).

targetReqs

Allowed:

difficulty

string

enum

Detection difficulty (console label: "Detection Difficulty").

Allowed:

callScenario

string

Scenario key (e.g. scenario1..scenario6) the call will be themed around (console label: "Call Scenario").

aiPersona

string

AI persona. Send "random" to randomize, or a persona id (persona1..persona12).

aiPersonaName

string

AI persona display name. Send "random" to randomize, or a free-text name (non letter/number/space characters stripped, capped at 50).

aiTone

string

AI tone. Send "random" to randomize, or a tone id (tone1..tone8).

aiVocal

string

AI voice. Send "random" to randomize, or "masculine"/"feminine" or a tenant-owned ElevenLabs custom voice ID.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Created

400Error