Contact

The Contact is a fundamental resource within SendX. It represents your customers, leads, or any person you wish to communicate with through your marketing campaigns.

Once a contact is added to SendX, you can send personalized marketing campaigns, manage their details, and track their interaction with your marketing activities.

SendX provides several key attributes associated with each contact. Additionally, custom fields allow you to add any extra information that may not be covered by the default fields. You can also categorize contacts using tags, and group them into lists for easier targeting in specific campaigns. Below is a detailed overview of the Contact schema.

FieldTypeDescriptionExample
idstringUnique identifier for the contact. Used to reference a contact in your application.contact_xxxxxxxx
firstNamestringFirst name of the contact.John
lastNamestringLast name of the contact.Doe
emailstring (email)Email address of the contact. This field is mandatory.john.doe@example.com
companystringCompany associated with the contact.Acme Corp
customFieldsobjectA key-value object of custom field IDs and their values.{ "field_xabc123": "Developer" }
unsubscribedbooleanIndicates if the contact has unsubscribed from emails.true
bouncedbooleanIndicates if the contact’s email address bounced.false
spambooleanIndicates if the contact marked your emails as spam.false
createdstring (date-time)ISO 8601 date-time when the contact was created.2025-06-23T11:01:24.936122Z
updatedstring (date-time)ISO 8601 date-time when the contact was last updated.2025-06-30T10:40:04.606013Z
blockedbooleanIndicates if the contact is blocked from receiving emails.false
droppedbooleanIndicates if emails to this contact were dropped.false
ltvintegerLifetime value (LTV) of the contact in currency units.0
contactSourceintegerIndicates how the contact was added.3
pageSourcestringSource page from which the contact was added.https://google.com
lastTrackedIpstringLast known IP address from which the contact was tracked.192.168.0.1
lists[string]List of list IDs associated with the contact.[ “list_K9ARTjg9U6ycvFvS8J4uRy” ]
tags[string]List of tag IDs associated with the contact.[ “tag_K9ARTjg9U6ycvFvS8J4uRy”, “tag_xyz456” ]

SendX REST API allows users to perform operations on any contact based on it’s identifier. Identifier can be either:

  • Contact ID of the contact (eg: contact_xxxxxxx)
  • Email of the contact (eg: linus@example.com)

List

A List in SendX is a collection of contacts, similar to organizing a guest list for an event. Depending on how the list is configured, there are two types of opt-in mechanisms:

  • Single Opt-in: In this type, contacts are directly added to the list once they provide their email address, just like guests who confirm their attendance without any extra steps.
  • Double Opt-in: In this type, contacts are sent a confirmation email and must verify their subscription before being fully added to the list. This is like sending a “Save the Date” invitation, where the guest needs to RSVP before they’re officially included.

These opt-in mechanisms help ensure that your contacts are either instantly subscribed (single opt-in) or confirmed (double opt-in) based on their preference. Lists allow you to group your contacts for targeted and personalized marketing campaigns.

FieldTypeDescriptionExample
idstringEncrypted identifier for the list.list_xxxxxxxx
namestringName of the list.Customer List
typeintegerType of the list.Possible values:0 = SingleOptIn1 = DoubleOptIn0
sendThankYouMailbooleanIndicates if a thank-you email should be sent after subscription.true
thankYouFromNamestringName shown as the sender for the thank-you email.Support Team
thankYouFromEmailstringEmail address from which the thank-you email is sent.support@sendx.io
thankYouMailSubjectstringSubject line of the thank-you email.Welcome to our newsletter
thankYouMailMessagestringContent of the thank-you email.Thank you for subscribing!
thankYouSenderstringSender ID for the thank-you email, if applicable.sender_xxxxxxxxx
confirmFromNamestringName shown as the sender for the confirmation email.Support Team
confirmFromEmailstringEmail address from which the confirmation email is sent.confirm@sendx.io
confirmMailSubjectstringSubject line of the confirmation email.Please confirm your subscription
confirmMailMessagestringContent of the confirmation email.Click here to confirm!
confirmSuccessPagestringURL of the success page shown after email confirmation.https://company.com/success
createdstring (date-time)Timestamp when the list was created.2025-06-26T05:09:39.485517Z
updatedstring (date-time)Timestamp when the list was last updated.2025-06-26T05:09:39.485517Z
confirmSenderstringSender ID for the confirmation email, if applicable.sender_xxxxxxxx
isQuarantinedbooleanIndicates if the list is quarantined. Contact support@sendx.io if you encounter this.false

Tag

A Tag in SendX is a versatile tool that allows you to categorize and organize your contacts based on their behaviors, interests, or other attributes. By adding tags to contacts, you can create powerful filters and segments to target specific audiences in your campaigns.

Tags are essential for tracking and understanding your contacts’ journey through your application or business funnel. For instance, if a contact views a product, you can assign a tag like Product X Viewed. Later, you can filter all contacts with this tag to send them personalized follow-up emails or promotional offers. This ability to categorize contacts ensures that your marketing efforts are precise and relevant.

In the world of email marketing, tags are not just a tool—they are a key utility for creating personalized experiences, improving open rates, and driving higher engagement. By leveraging tags effectively, you can ensure that your contacts receive the right message at the right time.

FieldTypeDescriptionExample
idstringIdentifier for the tag.tag_xxxxxxxx
namestringName of the tag.VIP Customers
createdstring (Date-Time)Timestamp when the tag was created.2024-10-08T09:30:00Z
updatedstring (Date-Time)Timestamp when the tag was last updated.2024-10-08T12:45:00Z

Campaigns

Campaign is one of the key resources in SendX as an email marketing platform. A campaign allows you to send targeted email messages to specific segments of your audience, helping to engage subscribers, promote products, or share important updates. Why is a Campaign Resource Important? Email campaigns are the cornerstone of email marketing strategies. They help you:

  • Engage Customers: Send relevant content that resonates with the audience.
  • Automate Communication: Schedule and automate emails to reach the right people at the right time.
  • Track Performance: Measure engagement, opens, clicks, and conversions to optimize future campaigns.


For example you might create a campaign called “Holiday Discounts” where you target customers who have shown interest in your products over the last three months. The campaign could send personalized emails with special discounts for the holiday season, encouraging recipients to take action.

The Campaign resource in SendX provides you with a powerful toolset to not only communicate with your audience but also to enhance their experience through targeted, automated, and personalized email strategies.

PropertyTypeDescriptionExample
idstringID of the campaigncampaign_xxxxxxxx
namestringName of the campaignNew Year Promotion
trackReplybooleanIndicates if replies to the campaign should be trackedfalse
statusintegerCurrent status of the campaign which can have these possible values:
0: Draft
1: Scheduled
2: Sending
3: Sent
4: Quarantined
Scheduled
scheduleTypeintegerType of schedule for the campaign
0: Schedule later
1: Send Now
2. Trigger via automation
3. Recurring
0
scheduleConditionstringCondition for scheduling the campaign, in case of Send Now this field remains empty. In case of Schedule later, this field denotes the date at which the campaign will be sent in YYYY-MM-DD format2024-12-30
timeConditionstringCondition for scheduling the campaign, in case of Send Now this field remains empty. In case of Schedule later, this field denotes the time at which the campaign will be sent in HH:MM AM/PM format9:00 AM
timezonestringTimezone for the scheduled send. See allowed timezones for the list of allowed timezonesAmerica/New_York
preferredTimeConditionstringpreferred time condition for the campaign9:00 AM
preferredTimezonestringPreferred timezone for sending the campaignAmerica/Los_Angeles
strategystringStrategy for the campaignBatch sending
sendInContactsTimezonebooleanIndicates if the campaign should be sent in the recipient’s timezonetrue
smartSendbooleanIndicates if smart sending should be usedfalse
isArchivedbooleanIndicates if the campaign is archivedfalse
senderstringUnique identifier of the sender of the campaignsender_123
campaignScreenshotUrlstringURL of the campaign’s screenshothttps://example.com/screenshot.png
includedSegmentsarrayList of segment IDs that are included in the campaign as receivers[“segment_123”, “segment_456”]
includedTagsarrayList of tag IDs that are included in the campaign as receivers[“tag_123”, “tag_456”]
includedListsarrayList of list IDs that are included in the campaign as receivers[“list_123”, “list_456”]
excludedSegmentsarrayList of segment IDs that are excluded from the campaign as receivers[“segment_123”, “segment_456”]
excludedTagsarrayList of tag IDs that are excluded from the campaign as receivers[“tag_123”, “tag_456”]
excludedListsarrayList of list IDs that are excluded from the campaign as receivers[“list_123”, “list_456”]

PreferredTimeZone and PreferredTimeCondition can are valid only in cases of SmartSend and SendInContactTimeZones, in case the user data is not available the preferredTimeZone and preferredTimeCondition is used.