PATCH
/
api
/
teams
/
{teamId}
/
outbound

Authorizations

Bearer API key
string
headerrequired

The API key used to authenticate requests, learn how to generate an API key on the Authentication page.

Body

application/json
followUpStrategy
enum<string>

The strategy used to calculate the follow-up interval.

Available options:
EXPONENTIAL,
FIBONACCI,
LINEAR
followUpIntervalDays
integer

The minimum number of days between follow-up emails.

followUpMaxCount
integer

The maximum number of follow-up emails that can be sent.

domainRedirectUrl
string

The website of the team where outbound domains should redirect to.

markAsLostDelayDays
integer

The number of days after the last email to mark a conversation as lost.

openTrackingEnabled
boolean

Whether open tracking is enabled for all campaigns by default.

clickTrackingEnabled
boolean

Whether click tracking is enabled for all campaigns by default.

autopilotCampaignStepsEnabled
boolean

Whether Autopilot for Sequences is enabled for all campaigns by default.

autopilotReplyErrorEnabled
boolean

Whether Autopilot is enabled for Error classifications for all campaigns by default.

autopilotReplyPositiveEnabled
boolean

Whether Autopilot is enabled for Positive classifications for all campaigns by default.

autopilotReplyNegativeEnabled
boolean

Whether Autopilot is enabled for Negative classifications for all campaigns by default.

autopilotReplyNeutralEnabled
boolean

Whether Autopilot is enabled for Neutral classifications for all campaigns by default.

autopilotReplyForwardedEnabled
boolean

Whether Autopilot is enabled for Forwarded classifications for all campaigns by default.

autopilotReplyMaybeLaterEnabled
boolean

Whether Autopilot is enabled for Maybe later classifications for all campaigns by default.

autopilotReplyOutOfOfficeEnabled
boolean

Whether Autopilot is enabled for Out-of-office classifications for all campaigns by default.

autopilotReplyAutomatedEnabled
boolean

Whether Autopilot is enabled for Automated classifications for all campaigns by default.

autopilotReplyInformationRequestedEnabled
boolean

Whether Autopilot is enabled for Information requested classifications for all campaigns by default.

dailySendTimes
object

The daily send window for each day of the week.

unsubscribeEnabled
boolean

Whether the unsubscribe link is enabled for all campaigns by default.

unsubscribeText
string

The text of the unsubscribe link.

forwardEmailsInbound
string[]

The email addresses to forward inbound emails to.

forwardEmailsOutbound
string[]

The email addresses to add as BCC recipients to outbound emails.

forwardReplyErrorEnabled
boolean

Whether to forward replies classified as Error to the team member associated with the conversation.

forwardReplyPositiveEnabled
boolean

Whether to forward replies classified as Positive to the team member associated with the conversation.

forwardReplyNegativeEnabled
boolean

Whether to forward replies classified as Negative to the team member associated with the conversation.

forwardReplyNeutralEnabled
boolean

Whether to forward replies classified as Neutral to the team member associated with the conversation.

forwardReplyForwardedEnabled
boolean

Whether to forward replies classified as Forwarded to the team member associated with the conversation.

forwardReplyMaybeLaterEnabled
boolean

Whether to forward replies classified as Maybe later to the team member associated with the conversation.

forwardReplyOutOfOfficeEnabled
boolean

Whether to forward replies classified as Out-of-office to the team member associated with the conversation.

forwardReplyAutomatedEnabled
boolean

Whether to forward replies classified as Automated to the team member associated with the conversation.

forwardReplyInformationRequestedEnabled
boolean

Whether to forward replies classified as Information requested to the team member associated with the conversation.

aggressiveness
integer

How aggressive the team is in sending follow-up emails.

Required range: 1 < x < 5

Response

200 - application/json
id
string
required

The unique ID of the team, starting with tea_.

createdAt
string
required

The date and time the team was created.

updatedAt
string
required

The date and time the team was last updated.

followUpStrategy
enum<string>

The strategy used to calculate the follow-up interval.

Available options:
EXPONENTIAL,
FIBONACCI,
LINEAR
followUpIntervalDays
integer

The minimum number of days between follow-up emails.

followUpMaxCount
integer

The maximum number of follow-up emails that can be sent.

domainRedirectUrl
string

The website of the team where outbound domains should redirect to.

markAsLostDelayDays
integer

The number of days after the last email to mark a conversation as lost.

openTrackingEnabled
boolean

Whether open tracking is enabled for all campaigns by default.

clickTrackingEnabled
boolean

Whether click tracking is enabled for all campaigns by default.

autopilotCampaignStepsEnabled
boolean

Whether Autopilot for Sequences is enabled for all campaigns by default.

autopilotReplyErrorEnabled
boolean

Whether Autopilot is enabled for Error classifications for all campaigns by default.

autopilotReplyPositiveEnabled
boolean

Whether Autopilot is enabled for Positive classifications for all campaigns by default.

autopilotReplyNegativeEnabled
boolean

Whether Autopilot is enabled for Negative classifications for all campaigns by default.

autopilotReplyNeutralEnabled
boolean

Whether Autopilot is enabled for Neutral classifications for all campaigns by default.

autopilotReplyForwardedEnabled
boolean

Whether Autopilot is enabled for Forwarded classifications for all campaigns by default.

autopilotReplyMaybeLaterEnabled
boolean

Whether Autopilot is enabled for Maybe later classifications for all campaigns by default.

autopilotReplyOutOfOfficeEnabled
boolean

Whether Autopilot is enabled for Out-of-office classifications for all campaigns by default.

autopilotReplyAutomatedEnabled
boolean

Whether Autopilot is enabled for Automated classifications for all campaigns by default.

autopilotReplyInformationRequestedEnabled
boolean

Whether Autopilot is enabled for Information requested classifications for all campaigns by default.

dailySendTimes
object

The daily send window for each day of the week.

unsubscribeEnabled
boolean

Whether the unsubscribe link is enabled for all campaigns by default.

unsubscribeText
string

The text of the unsubscribe link.

forwardEmailsInbound
string[]

The email addresses to forward inbound emails to.

forwardEmailsOutbound
string[]

The email addresses to add as BCC recipients to outbound emails.

forwardReplyErrorEnabled
boolean

Whether to forward replies classified as Error to the team member associated with the conversation.

forwardReplyPositiveEnabled
boolean

Whether to forward replies classified as Positive to the team member associated with the conversation.

forwardReplyNegativeEnabled
boolean

Whether to forward replies classified as Negative to the team member associated with the conversation.

forwardReplyNeutralEnabled
boolean

Whether to forward replies classified as Neutral to the team member associated with the conversation.

forwardReplyForwardedEnabled
boolean

Whether to forward replies classified as Forwarded to the team member associated with the conversation.

forwardReplyMaybeLaterEnabled
boolean

Whether to forward replies classified as Maybe later to the team member associated with the conversation.

forwardReplyOutOfOfficeEnabled
boolean

Whether to forward replies classified as Out-of-office to the team member associated with the conversation.

forwardReplyAutomatedEnabled
boolean

Whether to forward replies classified as Automated to the team member associated with the conversation.

forwardReplyInformationRequestedEnabled
boolean

Whether to forward replies classified as Information requested to the team member associated with the conversation.

aggressiveness
integer

How aggressive the team is in sending follow-up emails.

Required range: 1 < x < 5