ContactShipInstall

Summary

Create a new Agent in ContactShip with configurable attributes such as name, voice, time zone, language, and various call behavior settings. Optionally define agent properties individually or by providing a JSON object representing the agent configuration.

Inputs

• Name (required) — Internal name of the agent, visible only within ContactShip
• Voice (required) — Voice assigned to the agent, selectable from a searchable list or by voice ID; includes gender, accent, and language characteristics
• Time Zone (required) — IANA time zone identifier used for scheduling and timestamps in calls
• Configuration Mode (required) — Choose between defining individual agent fields or providing a raw JSON object with agent properties
• Additional Fields (if defining below) — Optional detailed settings including agent tag, ambient sound and volume, initial message and delay, boosted keywords for speech recognition, conversation purpose, interruption sensitivity, spoken language, maximum call duration, agent's spoken name, post-call custom data fields, agent prompt text, responsiveness, usable tools during calls, voice model, speech speed, voice variation, volume, and a webhook URL to receive post-call data
• Agent Fields JSON (if using JSON mode) — Raw JSON object containing agent properties as per ContactShip API specifications

Output shape

a single record

Returns the created agent object as returned by the ContactShip API, reflecting all provided configurations. The creation action immediately publishes the agent's first version.

Examples

Example 1: Create an agent named 'Showroom assistant' with a specific voice, active time zone, language set to Spanish (Latin America), and a prompt.

Name, Voice, Time Zone, Language, and Prompt fields set, others default or empty.

Links

• n8n community nodes installation guide