ByteChef LogoByteChef
Components

SendFox

SendFox lets you automate email campaigns, complete with custom opt-in forms and landing pages, so you're not tanking your budget to get new subscribers.

Categories: Advertising

Type: sendfox/v1


Connections

Version: 1

OAuth2 Authorization Code

Properties

NameLabelTypeDescriptionRequired
clientIdClient IdSTRINGtrue
clientSecretClient SecretSTRINGtrue

Actions

Create Contact

Name: createContact

Creates a new contact.

Properties

NameLabelTypeDescriptionRequired
emailEmail AddressSTRINGEmail address of the contact.true
first_nameFirst NameSTRINGFirst name of the contact.false
last_nameLast NameSTRINGLast name of the contact.false
listsListsARRAY
Items [INTEGER]
Lists to which the new contact will be added.false

Example JSON Structure

{
  "label" : "Create Contact",
  "name" : "createContact",
  "parameters" : {
    "email" : "",
    "first_name" : "",
    "last_name" : "",
    "lists" : [ 1 ]
  },
  "type" : "sendfox/v1/createContact"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGERID of the contact.
emailSTRINGEmail of the contact.
first_nameSTRINGFirst name of the contact.
last_nameSTRINGLast name of the contact.
ip_addressSTRINGIP address of the contact.
unsubscribed_atSTRINGDate when the contact unsubscribed.
bounced_atSTRINGDate when the contact was bounced.
created_atSTRINGDate when the contact was created.
updated_atSTRINGDate when the contact was updated.
form_idINTEGERForm ID of the contact.
contact_import_idINTEGERContact import ID of the contact.
via_apiBOOLEAN
Options true, false
Whether the contact was created via API.
last_opened_atSTRINGDate when the contact last opened an email.
last_clicked_atSTRINGDate when the contact last clicked an email.
first_sent_atSTRINGDate when the first email was sent to the contact.
last_sent_atSTRINGDate when the last email was sent to the contact.
invalid_atSTRINGDate when the contact became invalid.
inactive_atSTRINGDate when the contact became invalid.
confirmed_atSTRINGDate when the contact confirmed the subscription.
social_platform_idINTEGERSocial platform ID of the contact.
confirmation_sent_atSTRINGDate when the confirmation for the subscription was sent to the contact.
confirmation_sent_countINTEGERHow many confirmation emails were sent.
created_agoSTRINGHow many seconds ago was the contact created.
contact_fieldsARRAY
Items [{STRING(name), STRING(value)}]
Additional contact information.

Output Example

{
  "id" : 1,
  "email" : "",
  "first_name" : "",
  "last_name" : "",
  "ip_address" : "",
  "unsubscribed_at" : "",
  "bounced_at" : "",
  "created_at" : "",
  "updated_at" : "",
  "form_id" : 1,
  "contact_import_id" : 1,
  "via_api" : false,
  "last_opened_at" : "",
  "last_clicked_at" : "",
  "first_sent_at" : "",
  "last_sent_at" : "",
  "invalid_at" : "",
  "inactive_at" : "",
  "confirmed_at" : "",
  "social_platform_id" : 1,
  "confirmation_sent_at" : "",
  "confirmation_sent_count" : 1,
  "created_ago" : "",
  "contact_fields" : [ {
    "name" : "",
    "value" : ""
  } ]
}

Create List

Name: createList

Creates a new list.

Properties

NameLabelTypeDescriptionRequired
nameNameSTRINGName of the list.true

Example JSON Structure

{
  "label" : "Create List",
  "name" : "createList",
  "parameters" : {
    "name" : ""
  },
  "type" : "sendfox/v1/createList"
}

Output

Type: OBJECT

Properties

NameTypeDescription
nameSTRINGName of the list.
created_atSTRINGDate when the list was created.
idINTEGERID of the list.

Output Example

{
  "name" : "",
  "created_at" : "",
  "id" : 1
}

Unsubscribe Contact

Name: unsubscribeContact

Unsubscribes a contact.

Properties

NameLabelTypeDescriptionRequired
emailEmailSTRINGEmail of the Contact.true

Example JSON Structure

{
  "label" : "Unsubscribe Contact",
  "name" : "unsubscribeContact",
  "parameters" : {
    "email" : ""
  },
  "type" : "sendfox/v1/unsubscribeContact"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGERID of the contact.
emailSTRINGEmail of the contact.
first_nameSTRINGFirst name of the contact.
last_nameSTRINGLast name of the contact.
ip_addressSTRINGIP address of the contact.
unsubscribed_atSTRINGDate when the contact unsubscribed.
bounced_atSTRINGDate when the contact was bounced.
created_atSTRINGDate when the contact was created.
updated_atSTRINGDate when the contact was updated.
form_idINTEGERForm ID of the contact.
contact_import_idINTEGERContact import ID of the contact.
via_apiBOOLEAN
Options true, false
Whether the contact was created via API.
last_opened_atSTRINGDate when the contact last opened an email.
last_clicked_atSTRINGDate when the contact last clicked an email.
first_sent_atSTRINGDate when the first email was sent to the contact.
last_sent_atSTRINGDate when the last email was sent to the contact.
invalid_atSTRINGDate when the contact became invalid.
inactive_atSTRINGDate when the contact became invalid.
confirmed_atSTRINGDate when the contact confirmed the subscription.
social_platform_idINTEGERSocial platform ID of the contact.
confirmation_sent_atSTRINGDate when the confirmation for the subscription was sent to the contact.
confirmation_sent_countINTEGERHow many confirmation emails were sent.
created_agoSTRINGHow many seconds ago was the contact created.
contact_fieldsARRAY
Items [{STRING(name), STRING(value)}]
Additional contact information.

Output Example

{
  "id" : 1,
  "email" : "",
  "first_name" : "",
  "last_name" : "",
  "ip_address" : "",
  "unsubscribed_at" : "",
  "bounced_at" : "",
  "created_at" : "",
  "updated_at" : "",
  "form_id" : 1,
  "contact_import_id" : 1,
  "via_api" : false,
  "last_opened_at" : "",
  "last_clicked_at" : "",
  "first_sent_at" : "",
  "last_sent_at" : "",
  "invalid_at" : "",
  "inactive_at" : "",
  "confirmed_at" : "",
  "social_platform_id" : 1,
  "confirmation_sent_at" : "",
  "confirmation_sent_count" : 1,
  "created_ago" : "",
  "contact_fields" : [ {
    "name" : "",
    "value" : ""
  } ]
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.