Get outbound settings - FirstQuadrant Docs

GET

api

teams

{teamId}

outbound

curl --request GET \
  --url https://firstquadrant.ai/api/teams/{teamId}/outbound \
  --header 'Bearer API key: <api-key>'

{
  "id": "tea_qxwVhUwAj3ijxWXstmCNvIII",
  "createdAt": "2024-05-12T00:00:00.000Z",
  "updatedAt": "2024-05-12T00:00:00.000Z",
  "followUpStrategy": "EXPONENTIAL",
  "followUpIntervalDays": 3,
  "followUpMaxCount": 5,
  "domainRedirectUrl": "https://firstquadrant.ai",
  "markAsLostDelayDays": 7,
  "openTrackingEnabled": true,
  "clickTrackingEnabled": true,
  "autopilotCampaignStepsEnabled": true,
  "autopilotReplyErrorEnabled": true,
  "autopilotReplyPositiveEnabled": true,
  "autopilotReplyNegativeEnabled": true,
  "autopilotReplyNeutralEnabled": true,
  "autopilotReplyForwardedEnabled": true,
  "autopilotReplyMaybeLaterEnabled": true,
  "autopilotReplyOutOfOfficeEnabled": true,
  "autopilotReplyAutomatedEnabled": true,
  "autopilotReplyInformationRequestedEnabled": true,
  "dailySendTimes": {
    "monday": {
      "start": "09:00",
      "end": "17:00"
    },
    "tuesday": {
      "start": "09:00",
      "end": "17:00"
    },
    "wednesday": {
      "start": "09:00",
      "end": "17:00"
    },
    "thursday": {
      "start": "09:00",
      "end": "17:00"
    },
    "friday": {
      "start": "09:00",
      "end": "17:00"
    },
    "saturday": {
      "start": "09:00",
      "end": "17:00"
    },
    "sunday": {
      "start": "09:00",
      "end": "17:00"
    }
  },
  "unsubscribeEnabled": true,
  "unsubscribeText": "If you don't want to hear from me, [let me know](#unsubscribe-link).",
  "forwardEmailsInbound": [
    "enquiry@firstquadrant.ai"
  ],
  "forwardEmailsOutbound": [
    "enquiry@firstquadrant.ai"
  ],
  "forwardReplyErrorEnabled": true,
  "forwardReplyPositiveEnabled": true,
  "forwardReplyNegativeEnabled": true,
  "forwardReplyNeutralEnabled": true,
  "forwardReplyForwardedEnabled": true,
  "forwardReplyMaybeLaterEnabled": true,
  "forwardReplyOutOfOfficeEnabled": true,
  "forwardReplyAutomatedEnabled": true,
  "forwardReplyInformationRequestedEnabled": true,
  "aggressiveness": 3
}

Authorizations

Bearer API key

string

header

required

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

Response

200 - application/json

Outbound settings object

string

required

The unique ID of the team, starting with tea_.

Example:

"tea_qxwVhUwAj3ijxWXstmCNvIII"

createdAt

string

required

The date and time the team was created.

Example:

"2024-05-12T00:00:00.000Z"

updatedAt

string

required

The date and time the team was last updated.

Example:

"2024-05-12T00:00:00.000Z"

followUpStrategy

enum<string>

The strategy used to calculate the follow-up interval.

Available options:

EXPONENTIAL,

FIBONACCI,

LINEAR

Example:

"EXPONENTIAL"

followUpIntervalDays

integer

The minimum number of days between follow-up emails.

Example:

3

followUpMaxCount

integer

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

Example:

5

domainRedirectUrl

string

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

Example:

"https://firstquadrant.ai"

markAsLostDelayDays

integer

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

Example:

7

openTrackingEnabled

boolean

Whether open tracking is enabled for all campaigns by default.

Example:

true

clickTrackingEnabled

boolean

Whether click tracking is enabled for all campaigns by default.

Example:

true

autopilotCampaignStepsEnabled

boolean

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

Example:

true

autopilotReplyErrorEnabled

boolean

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

Example:

true

autopilotReplyPositiveEnabled

boolean

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

Example:

true

autopilotReplyNegativeEnabled

boolean

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

Example:

true

autopilotReplyNeutralEnabled

boolean

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

Example:

true

autopilotReplyForwardedEnabled

boolean

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

Example:

true

autopilotReplyMaybeLaterEnabled

boolean

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

Example:

true

autopilotReplyOutOfOfficeEnabled

boolean

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

Example:

true

autopilotReplyAutomatedEnabled

boolean

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

Example:

true

autopilotReplyInformationRequestedEnabled

boolean

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

Example:

true

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.

Example:

true

unsubscribeText

string

The text of the unsubscribe link.

Example:

"If you don't want to hear from me, [let me know](#unsubscribe-link)."

forwardEmailsInbound

string[]

The email addresses to forward inbound emails to.

Example:

["enquiry@firstquadrant.ai"]

forwardEmailsOutbound

string[]

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

Example:

["enquiry@firstquadrant.ai"]

forwardReplyErrorEnabled

boolean

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

Example:

true

forwardReplyPositiveEnabled

boolean

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

Example:

true

forwardReplyNegativeEnabled

boolean

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

Example:

true

forwardReplyNeutralEnabled

boolean

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

Example:

true

forwardReplyForwardedEnabled

boolean

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

Example:

true

forwardReplyMaybeLaterEnabled

boolean

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

Example:

true

forwardReplyOutOfOfficeEnabled

boolean

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

Example:

true

forwardReplyAutomatedEnabled

boolean

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

Example:

true

forwardReplyInformationRequestedEnabled

boolean

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

Example:

true

aggressiveness

integer

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

Required range: 1 <= x <= 5

Example:

3

curl --request GET \
  --url https://firstquadrant.ai/api/teams/{teamId}/outbound \
  --header 'Bearer API key: <api-key>'

{
  "id": "tea_qxwVhUwAj3ijxWXstmCNvIII",
  "createdAt": "2024-05-12T00:00:00.000Z",
  "updatedAt": "2024-05-12T00:00:00.000Z",
  "followUpStrategy": "EXPONENTIAL",
  "followUpIntervalDays": 3,
  "followUpMaxCount": 5,
  "domainRedirectUrl": "https://firstquadrant.ai",
  "markAsLostDelayDays": 7,
  "openTrackingEnabled": true,
  "clickTrackingEnabled": true,
  "autopilotCampaignStepsEnabled": true,
  "autopilotReplyErrorEnabled": true,
  "autopilotReplyPositiveEnabled": true,
  "autopilotReplyNegativeEnabled": true,
  "autopilotReplyNeutralEnabled": true,
  "autopilotReplyForwardedEnabled": true,
  "autopilotReplyMaybeLaterEnabled": true,
  "autopilotReplyOutOfOfficeEnabled": true,
  "autopilotReplyAutomatedEnabled": true,
  "autopilotReplyInformationRequestedEnabled": true,
  "dailySendTimes": {
    "monday": {
      "start": "09:00",
      "end": "17:00"
    },
    "tuesday": {
      "start": "09:00",
      "end": "17:00"
    },
    "wednesday": {
      "start": "09:00",
      "end": "17:00"
    },
    "thursday": {
      "start": "09:00",
      "end": "17:00"
    },
    "friday": {
      "start": "09:00",
      "end": "17:00"
    },
    "saturday": {
      "start": "09:00",
      "end": "17:00"
    },
    "sunday": {
      "start": "09:00",
      "end": "17:00"
    }
  },
  "unsubscribeEnabled": true,
  "unsubscribeText": "If you don't want to hear from me, [let me know](#unsubscribe-link).",
  "forwardEmailsInbound": [
    "enquiry@firstquadrant.ai"
  ],
  "forwardEmailsOutbound": [
    "enquiry@firstquadrant.ai"
  ],
  "forwardReplyErrorEnabled": true,
  "forwardReplyPositiveEnabled": true,
  "forwardReplyNegativeEnabled": true,
  "forwardReplyNeutralEnabled": true,
  "forwardReplyForwardedEnabled": true,
  "forwardReplyMaybeLaterEnabled": true,
  "forwardReplyOutOfOfficeEnabled": true,
  "forwardReplyAutomatedEnabled": true,
  "forwardReplyInformationRequestedEnabled": true,
  "aggressiveness": 3
}

FirstQuadrant API

Authorizations

Response