Skip to main content
POST
Create a new sender profile.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Profile data

Request body for creating a sender profile

email
string
required

Sender email address

name
string
required

Profile name

agentId
string

Agent ID that drives this profile's agent-conversation steps. To find valid IDs, call agents_listAgents.

dailySendingLimit
integer

Daily email sending limit

employeeId
string

Optional employee persona to associate with this profile.

integrationId
string

Email integration ID this profile sends from. To find valid IDs, call integrations_getIntegrationsByType with path integration_type=email.

linkedinIntegrationId
string

This profile's LinkedIn account for LinkedIn steps. To find valid IDs, call integrations_getIntegrationsByType with path integration_type=browser_session and query type=linkedin_login.

phone
string

Sending phone number (E.164) for this profile, drawn from phoneIntegrationId. To find available numbers, call integrations_getTwilioPhoneNumbers with that integration_id.

phoneIntegrationId
string

This profile's Twilio/phone integration for SMS and voice steps. To find valid IDs, call integrations_getIntegrationsByType with path integration_type=sms.

signature
string

Email signature HTML

voiceId
string

Voice ID for this profile's voice-message steps. To find valid IDs, call voices_listVoices.

Response

Created profile