BranchesTags

Repository files navigation

SendX Ruby SDK

SendX REST API Documentation

🚀 Introduction

The SendX API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Key Features:

  • 🔒 Security: Team-based authentication with optional member-level access
  • 🎯 Resource-Oriented: RESTful design with clear resource boundaries
  • 📊 Rich Data Models: Three-layer model system (Input/Output/Internal)
  • 🔗 Relationships: Automatic prefix handling for resource relationships
  • 📈 Scalable: Built for high-volume email marketing operations

🏗️ Architecture Overview

SendX uses a three-layer model architecture:

  1. Input Models (RestE*): For API requests
  2. Output Models (RestR*): For API responses with prefixed IDs
  3. Internal Models: Core business logic (not exposed in API)

🔐 Security & Authentication

SendX uses API key authentication:

Team API Key

X-Team-ApiKey: YOUR_TEAM_API_KEY
  • Required for all requests
  • Team-level access to resources
  • Available in SendX Settings → Team API Key

🆔 Encrypted ID System

SendX uses encrypted IDs for security and better developer experience:

  • Internal IDs: Sequential integers (not exposed)
  • Encrypted IDs: 22-character alphanumeric strings
  • Prefixed IDs: Resource-type prefixes in API responses (contact_<22-char-id>)

ID Format

All resource IDs follow this pattern:

<resource_prefix>_<22_character_alphanumeric_string>

Example:

{
"id": "contact_BnKjkbBBS500CoBCP0oChQ",
"lists": ["list_OcuxJHdiAvujmwQVJfd3ss", "list_0tOFLp5RgV7s3LNiHrjGYs"],
"tags": ["tag_UhsDkjL772Qbj5lWtT62VK", "tag_fL7t9lsnZ9swvx2HrtQ9wM"]
}

📚 Resource Prefixes

ResourcePrefixExample
Contactcontact_contact_BnKjkbBBS500CoBCP0oChQ
Campaigncampaign_campaign_LUE9BTxmksSmqHWbh96zsn
Listlist_list_OcuxJHdiAvujmwQVJfd3ss
Tagtag_tag_UhsDkjL772Qbj5lWtT62VK
Sendersender_sender_4vK3WFhMgvOwUNyaL4QxCD
Templatetemplate_template_f3lJvTEhSjKGVb5Lwc5SWS
Custom Fieldfield_field_MnuqBAG2NPLm7PZMWbjQxt
Webhookwebhook_webhook_9l154iiXlZoPo7vngmamee
Postpost_post_XyZ123aBc456DeF789GhI
Post Categorypost_category_post_category_YzS1wOU20yw87UUHKxMzwn
Post Tagpost_tag_post_tag_123XyZ456AbC
Membermember_member_JkL012MnO345PqR678

🎯 Best Practices

Error Handling

  • Always check status codes: 2xx = success, 4xx = client error, 5xx = server error
  • Read error messages: Descriptive messages help debug issues
  • Handle rate limits: Respect API rate limits for optimal performance

Data Validation

  • Email format: Must be valid email addresses
  • Required fields: Check documentation for mandatory fields
  • Field lengths: Respect maximum length constraints

Performance

  • Pagination: Use offset/limit for large datasets
  • Batch operations: Process multiple items when supported
  • Caching: Cache responses when appropriate

🛠️ SDKs & Integration

Official SDKs available for:

📞 Support

Need help? Contact us:

  • 💬 Website Chat: Available on sendx.io
  • 📧 Email: hello@sendx.io
  • 📚 Documentation: Full guides at help.sendx.io

API Endpoint:https://api.sendx.io/api/v1/rest

Installation

To install the gem:

Install via command line

gem install sendx-ruby-sdk

Install via Gemfile

source "https://rubygems.pkg.github.com/sendx" do
gem "sendx-ruby-sdk", "1.1.0"
end

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gemrequire'sendx-ruby-sdk'# Setup authorizationSendX.configuredo |config|
# Configure API key authorization: TeamApiKeyconfig.api_key['X-Team-ApiKey']='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['X-Team-ApiKey'] = 'Bearer'endapi_instance=SendX::ContactApi.newcontact_request=SendX::ContactRequest.new(email: "john@doe.com",first_name: "John",last_name: "Doe",company: "SendX",last_tracked_ip: "34.94.159.140",tags: ["tag_MKdhTovsTJDetCyrJmRySL"],custom_fields: {'custom_field_MKdhTovsTJDetCyrJmRySe'=>"VIP","custom_field_MKdhTovsTFDetCyrJerRySL"=>"Subscribers"},)begin# Create a contactresult=api_instance.create_contact(contact_request)presultrescueSendX::ApiError=>eputs"Error when calling ContactApi->create_contact: #{e}"end

Documentation for API Endpoints

All URIs are relative to https://api.sendx.io/api/v1/rest

ClassMethodHTTP requestDescription
SendX::CampaignApicreate_campaignPOST /campaignCreate campaign
SendX::CampaignApidelete_campaignDELETE /campaign/{identifier}Delete campaign
SendX::CampaignApiget_all_campaignsGET /campaignGet all campaigns
SendX::CampaignApiget_campaignGET /campaign/{identifier}Get campaign by ID
SendX::ContactApicreate_contactPOST /contactCreate a new contact
SendX::ContactApidelete_contactDELETE /contact/{identifier}Delete contact
SendX::ContactApiget_all_contactsGET /contactGet all contacts
SendX::ContactApiget_contactGET /contact/{identifier}Get contact by ID
SendX::ContactApiunsubscribe_contactPOST /contact/unsubscribe/{identifier}Unsubscribe contact
SendX::ContactApiupdate_contactPUT /contact/{identifier}Update contact
SendX::CustomFieldApicreate_custom_fieldPOST /customfieldCreate custom field
SendX::CustomFieldApidelete_custom_fieldDELETE /customfield/{identifier}Delete custom field
SendX::CustomFieldApiget_all_custom_fieldsGET /customfieldGet all custom fields
SendX::CustomFieldApiget_custom_fieldGET /customfield/{identifier}Get custom field by ID
SendX::CustomFieldApiupdate_custom_fieldPUT /customfield/{identifier}Update custom field
SendX::EmailSendingApisend_emailPOST /send/emailSend transactional email
SendX::EmailSendingApisend_email_with_templatePOST /send/templateSend email using template
SendX::EventApievents_custom_postback_getGET /events/custom/postbackCustom Event Postback URL
SendX::EventApievents_revenue_postback_getGET /events/revenue/postbackRevenue Event Postback URL
SendX::EventsApitrack_custom_eventPOST /events/customTrack custom event
SendX::EventsApitrack_revenue_eventPOST /events/revenueTrack revenue event
SendX::ListApicreate_listPOST /listCreate list
SendX::ListApidelete_listDELETE /list/{identifier}Delete list
SendX::ListApiget_all_listsGET /listGet all lists
SendX::ListApiget_listGET /list/{identifier}Get list by ID
SendX::ListApiupdate_listPUT /list/{identifier}Update list
SendX::PostApicreate_postPOST /postCreate blog post
SendX::PostApidelete_postDELETE /post/{identifier}Delete post
SendX::PostApiget_all_postsGET /postGet all posts
SendX::PostApiget_postGET /post/{identifier}Get post by ID
SendX::PostApiupdate_postPUT /post/{identifier}Update post
SendX::PostCategoryApicreate_post_categoryPOST /post/categoryCreate post category
SendX::PostCategoryApidelete_post_categoryDELETE /post/category/{identifier}Delete post category
SendX::PostCategoryApiget_all_post_categoriesGET /post/categoryGet all post categories
SendX::PostCategoryApiget_post_categoryGET /post/category/{identifier}Get post category by ID
SendX::PostCategoryApiupdate_post_categoryPUT /post/category/{identifier}Update post category
SendX::PostTagApicreate_post_tagPOST /post/tagCreate post tag
SendX::PostTagApidelete_post_tagDELETE /post/tag/{identifier}Delete post tag
SendX::PostTagApiget_all_post_tagsGET /post/tagGet all post tags
SendX::PostTagApiget_post_tagGET /post/tag/{identifier}Get post tag by ID
SendX::PostTagApiupdate_post_tagPUT /post/tag/{identifier}Update post tag
SendX::ReportApiget_campaign_reportGET /report/campaign/{identifier}Get campaign report
SendX::SenderApicreate_senderPOST /senderCreate sender
SendX::SenderApiget_all_sendersGET /senderGet all senders
SendX::TagApicreate_tagPOST /tagCreate tag
SendX::TagApidelete_tagDELETE /tag/{identifier}Delete tag
SendX::TagApiget_all_tagsGET /tagGet all tags
SendX::TagApiget_tagGET /tag/{identifier}Get tag by ID
SendX::TagApiupdate_tagPUT /tag/{identifier}Update tag
SendX::TeamMemberApiget_all_team_membersGET /team/memberGet all team members
SendX::TeamMemberApiget_team_memberGET /team/member/{identifier}Get a team member by ID
SendX::TemplateApicreate_email_templatePOST /template/emailCreate email template
SendX::TemplateApidelete_email_templateDELETE /template/email/{identifier}Delete template
SendX::TemplateApiget_all_email_templatesGET /template/emailGet all templates
SendX::TemplateApiget_email_templateGET /template/email/{identifier}Get template by ID
SendX::TemplateApiupdate_email_templatePUT /template/email/{identifier}Update template
SendX::TrackingApiidentify_contactPOST /contact/identifyIdentify contact
SendX::TrackingApitrack_contactPOST /contact/trackTrack contact
SendX::WebhookApicreate_webhookPOST /webhookCreate webhook
SendX::WebhookApidelete_webhookDELETE /webhook/{identifier}Delete webhook
SendX::WebhookApiget_all_webhooksGET /webhookGet all webhooks
SendX::WebhookApiget_webhookGET /webhook/{identifier}Get webhook by ID
SendX::WebhookApiupdate_webhookPUT /webhook/{identifier}Update webhook

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

TeamApiKey

  • Type: API key
  • API key parameter name: X-Team-ApiKey
  • Location: HTTP header

About

No description, website, or topics provided.

Resources

Readme
MIT license
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
BranchesTags
Repository files navigation
SendX Ruby SDK
SendX REST API Documentation
🚀 Introduction
The SendX API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Key Features:
  • 🔒 Security: Team-based authentication with optional member-level access
  • 🎯 Resource-Oriented: RESTful design with clear resource boundaries
  • 📊 Rich Data Models: Three-layer model system (Input/Output/Internal)
  • 🔗 Relationships: Automatic prefix handling for resource relationships
  • 📈 Scalable: Built for high-volume email marketing operations
🏗️ Architecture Overview
SendX uses a three-layer model architecture:
  1. Input Models (RestE*): For API requests
  2. Output Models (RestR*): For API responses with prefixed IDs
  3. Internal Models: Core business logic (not exposed in API)
🔐 Security & Authentication
SendX uses API key authentication:
Team API Key
X-Team-ApiKey: YOUR_TEAM_API_KEY
  • Required for all requests
  • Team-level access to resources
  • Available in SendX Settings → Team API Key
🆔 Encrypted ID System
SendX uses encrypted IDs for security and better developer experience:
  • Internal IDs: Sequential integers (not exposed)
  • Encrypted IDs: 22-character alphanumeric strings
  • Prefixed IDs: Resource-type prefixes in API responses (contact_<22-char-id>)
ID Format
All resource IDs follow this pattern:
<resource_prefix>_<22_character_alphanumeric_string>

Example:
{
"id": "contact_BnKjkbBBS500CoBCP0oChQ",
"lists": ["list_OcuxJHdiAvujmwQVJfd3ss", "list_0tOFLp5RgV7s3LNiHrjGYs"],
"tags": ["tag_UhsDkjL772Qbj5lWtT62VK", "tag_fL7t9lsnZ9swvx2HrtQ9wM"]
}
📚 Resource Prefixes
ResourcePrefixExample
Contactcontact_contact_BnKjkbBBS500CoBCP0oChQ
Campaigncampaign_campaign_LUE9BTxmksSmqHWbh96zsn
Listlist_list_OcuxJHdiAvujmwQVJfd3ss
Tagtag_tag_UhsDkjL772Qbj5lWtT62VK
Sendersender_sender_4vK3WFhMgvOwUNyaL4QxCD
Templatetemplate_template_f3lJvTEhSjKGVb5Lwc5SWS
Custom Fieldfield_field_MnuqBAG2NPLm7PZMWbjQxt
Webhookwebhook_webhook_9l154iiXlZoPo7vngmamee
Postpost_post_XyZ123aBc456DeF789GhI
Post Categorypost_category_post_category_YzS1wOU20yw87UUHKxMzwn
Post Tagpost_tag_post_tag_123XyZ456AbC
Membermember_member_JkL012MnO345PqR678
🎯 Best Practices
Error Handling
  • Always check status codes: 2xx = success, 4xx = client error, 5xx = server error
  • Read error messages: Descriptive messages help debug issues
  • Handle rate limits: Respect API rate limits for optimal performance
Data Validation
  • Email format: Must be valid email addresses
  • Required fields: Check documentation for mandatory fields
  • Field lengths: Respect maximum length constraints
Performance
  • Pagination: Use offset/limit for large datasets
  • Batch operations: Process multiple items when supported
  • Caching: Cache responses when appropriate
🛠️ SDKs & Integration
Official SDKs available for:
📞 Support
Need help? Contact us:
  • 💬 Website Chat: Available on sendx.io
  • 📧 Email: hello@sendx.io
  • 📚 Documentation: Full guides at help.sendx.io
API Endpoint:https://api.sendx.io/api/v1/rest
Installation
To install the gem:
Install via command line
gem install sendx-ruby-sdk

Install via Gemfile
source "https://rubygems.pkg.github.com/sendx" do
gem "sendx-ruby-sdk", "1.1.0"
end

Getting Started
Please follow the installation procedure and then run the following code:
# Load the gemrequire'sendx-ruby-sdk'# Setup authorizationSendX.configuredo |config|
# Configure API key authorization: TeamApiKeyconfig.api_key['X-Team-ApiKey']='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['X-Team-ApiKey'] = 'Bearer'endapi_instance=SendX::ContactApi.newcontact_request=SendX::ContactRequest.new(email: "john@doe.com",first_name: "John",last_name: "Doe",company: "SendX",last_tracked_ip: "34.94.159.140",tags: ["tag_MKdhTovsTJDetCyrJmRySL"],custom_fields: {'custom_field_MKdhTovsTJDetCyrJmRySe'=>"VIP","custom_field_MKdhTovsTFDetCyrJerRySL"=>"Subscribers"},)begin# Create a contactresult=api_instance.create_contact(contact_request)presultrescueSendX::ApiError=>eputs"Error when calling ContactApi->create_contact: #{e}"end
Documentation for API Endpoints
All URIs are relative to https://api.sendx.io/api/v1/rest
ClassMethodHTTP requestDescription
SendX::CampaignApicreate_campaignPOST /campaignCreate campaign
SendX::CampaignApidelete_campaignDELETE /campaign/{identifier}Delete campaign
SendX::CampaignApiget_all_campaignsGET /campaignGet all campaigns
SendX::CampaignApiget_campaignGET /campaign/{identifier}Get campaign by ID
SendX::ContactApicreate_contactPOST /contactCreate a new contact
SendX::ContactApidelete_contactDELETE /contact/{identifier}Delete contact
SendX::ContactApiget_all_contactsGET /contactGet all contacts
SendX::ContactApiget_contactGET /contact/{identifier}Get contact by ID
SendX::ContactApiunsubscribe_contactPOST /contact/unsubscribe/{identifier}Unsubscribe contact
SendX::ContactApiupdate_contactPUT /contact/{identifier}Update contact
SendX::CustomFieldApicreate_custom_fieldPOST /customfieldCreate custom field
SendX::CustomFieldApidelete_custom_fieldDELETE /customfield/{identifier}Delete custom field
SendX::CustomFieldApiget_all_custom_fieldsGET /customfieldGet all custom fields
SendX::CustomFieldApiget_custom_fieldGET /customfield/{identifier}Get custom field by ID
SendX::CustomFieldApiupdate_custom_fieldPUT /customfield/{identifier}Update custom field
SendX::EmailSendingApisend_emailPOST /send/emailSend transactional email
SendX::EmailSendingApisend_email_with_templatePOST /send/templateSend email using template
SendX::EventApievents_custom_postback_getGET /events/custom/postbackCustom Event Postback URL
SendX::EventApievents_revenue_postback_getGET /events/revenue/postbackRevenue Event Postback URL
SendX::EventsApitrack_custom_eventPOST /events/customTrack custom event
SendX::EventsApitrack_revenue_eventPOST /events/revenueTrack revenue event
SendX::ListApicreate_listPOST /listCreate list
SendX::ListApidelete_listDELETE /list/{identifier}Delete list
SendX::ListApiget_all_listsGET /listGet all lists
SendX::ListApiget_listGET /list/{identifier}Get list by ID
SendX::ListApiupdate_listPUT /list/{identifier}Update list
SendX::PostApicreate_postPOST /postCreate blog post
SendX::PostApidelete_postDELETE /post/{identifier}Delete post
SendX::PostApiget_all_postsGET /postGet all posts
SendX::PostApiget_postGET /post/{identifier}Get post by ID
SendX::PostApiupdate_postPUT /post/{identifier}Update post
SendX::PostCategoryApicreate_post_categoryPOST /post/categoryCreate post category
SendX::PostCategoryApidelete_post_categoryDELETE /post/category/{identifier}Delete post category
SendX::PostCategoryApiget_all_post_categoriesGET /post/categoryGet all post categories
SendX::PostCategoryApiget_post_categoryGET /post/category/{identifier}Get post category by ID
SendX::PostCategoryApiupdate_post_categoryPUT /post/category/{identifier}Update post category
SendX::PostTagApicreate_post_tagPOST /post/tagCreate post tag
SendX::PostTagApidelete_post_tagDELETE /post/tag/{identifier}Delete post tag
SendX::PostTagApiget_all_post_tagsGET /post/tagGet all post tags
SendX::PostTagApiget_post_tagGET /post/tag/{identifier}Get post tag by ID
SendX::PostTagApiupdate_post_tagPUT /post/tag/{identifier}Update post tag
SendX::ReportApiget_campaign_reportGET /report/campaign/{identifier}Get campaign report
SendX::SenderApicreate_senderPOST /senderCreate sender
SendX::SenderApiget_all_sendersGET /senderGet all senders
SendX::TagApicreate_tagPOST /tagCreate tag
SendX::TagApidelete_tagDELETE /tag/{identifier}Delete tag
SendX::TagApiget_all_tagsGET /tagGet all tags
SendX::TagApiget_tagGET /tag/{identifier}Get tag by ID
SendX::TagApiupdate_tagPUT /tag/{identifier}Update tag
SendX::TeamMemberApiget_all_team_membersGET /team/memberGet all team members
SendX::TeamMemberApiget_team_memberGET /team/member/{identifier}Get a team member by ID
SendX::TemplateApicreate_email_templatePOST /template/emailCreate email template
SendX::TemplateApidelete_email_templateDELETE /template/email/{identifier}Delete template
SendX::TemplateApiget_all_email_templatesGET /template/emailGet all templates
SendX::TemplateApiget_email_templateGET /template/email/{identifier}Get template by ID
SendX::TemplateApiupdate_email_templatePUT /template/email/{identifier}Update template
SendX::TrackingApiidentify_contactPOST /contact/identifyIdentify contact
SendX::TrackingApitrack_contactPOST /contact/trackTrack contact
SendX::WebhookApicreate_webhookPOST /webhookCreate webhook
SendX::WebhookApidelete_webhookDELETE /webhook/{identifier}Delete webhook
SendX::WebhookApiget_all_webhooksGET /webhookGet all webhooks
SendX::WebhookApiget_webhookGET /webhook/{identifier}Get webhook by ID
SendX::WebhookApiupdate_webhookPUT /webhook/{identifier}Update webhook
Documentation for Models
Documentation for Authorization
Authentication schemes defined for the API:
TeamApiKey
  • Type: API key
  • API key parameter name: X-Team-ApiKey
  • Location: HTTP header
About
No description, website, or topics provided.
Resources
Readme
MIT license
Activity
Custom properties
Stars
0 stars
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
BranchesTags
Repository files navigation
SendX Ruby SDK
SendX REST API Documentation
🚀 Introduction
The SendX API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Key Features:
  • 🔒 Security: Team-based authentication with optional member-level access
  • 🎯 Resource-Oriented: RESTful design with clear resource boundaries
  • 📊 Rich Data Models: Three-layer model system (Input/Output/Internal)
  • 🔗 Relationships: Automatic prefix handling for resource relationships
  • 📈 Scalable: Built for high-volume email marketing operations
🏗️ Architecture Overview
SendX uses a three-layer model architecture:
  1. Input Models (RestE*): For API requests
  2. Output Models (RestR*): For API responses with prefixed IDs
  3. Internal Models: Core business logic (not exposed in API)
🔐 Security & Authentication
SendX uses API key authentication:
Team API Key
X-Team-ApiKey: YOUR_TEAM_API_KEY
  • Required for all requests
  • Team-level access to resources
  • Available in SendX Settings → Team API Key
🆔 Encrypted ID System
SendX uses encrypted IDs for security and better developer experience:
  • Internal IDs: Sequential integers (not exposed)
  • Encrypted IDs: 22-character alphanumeric strings
  • Prefixed IDs: Resource-type prefixes in API responses (contact_<22-char-id>)
ID Format
All resource IDs follow this pattern:
<resource_prefix>_<22_character_alphanumeric_string>

Example:
{
"id": "contact_BnKjkbBBS500CoBCP0oChQ",
"lists": ["list_OcuxJHdiAvujmwQVJfd3ss", "list_0tOFLp5RgV7s3LNiHrjGYs"],
"tags": ["tag_UhsDkjL772Qbj5lWtT62VK", "tag_fL7t9lsnZ9swvx2HrtQ9wM"]
}
📚 Resource Prefixes
ResourcePrefixExample
Contactcontact_contact_BnKjkbBBS500CoBCP0oChQ
Campaigncampaign_campaign_LUE9BTxmksSmqHWbh96zsn
Listlist_list_OcuxJHdiAvujmwQVJfd3ss
Tagtag_tag_UhsDkjL772Qbj5lWtT62VK
Sendersender_sender_4vK3WFhMgvOwUNyaL4QxCD
Templatetemplate_template_f3lJvTEhSjKGVb5Lwc5SWS
Custom Fieldfield_field_MnuqBAG2NPLm7PZMWbjQxt
Webhookwebhook_webhook_9l154iiXlZoPo7vngmamee
Postpost_post_XyZ123aBc456DeF789GhI
Post Categorypost_category_post_category_YzS1wOU20yw87UUHKxMzwn
Post Tagpost_tag_post_tag_123XyZ456AbC
Membermember_member_JkL012MnO345PqR678
🎯 Best Practices
Error Handling
  • Always check status codes: 2xx = success, 4xx = client error, 5xx = server error
  • Read error messages: Descriptive messages help debug issues
  • Handle rate limits: Respect API rate limits for optimal performance
Data Validation
  • Email format: Must be valid email addresses
  • Required fields: Check documentation for mandatory fields
  • Field lengths: Respect maximum length constraints
Performance
  • Pagination: Use offset/limit for large datasets
  • Batch operations: Process multiple items when supported
  • Caching: Cache responses when appropriate
🛠️ SDKs & Integration
Official SDKs available for:
📞 Support
Need help? Contact us:
  • 💬 Website Chat: Available on sendx.io
  • 📧 Email: hello@sendx.io
  • 📚 Documentation: Full guides at help.sendx.io
API Endpoint:https://api.sendx.io/api/v1/rest
Installation
To install the gem:
Install via command line
gem install sendx-ruby-sdk

Install via Gemfile
source "https://rubygems.pkg.github.com/sendx" do
gem "sendx-ruby-sdk", "1.1.0"
end

Getting Started
Please follow the installation procedure and then run the following code:
# Load the gemrequire'sendx-ruby-sdk'# Setup authorizationSendX.configuredo |config|
# Configure API key authorization: TeamApiKeyconfig.api_key['X-Team-ApiKey']='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['X-Team-ApiKey'] = 'Bearer'endapi_instance=SendX::ContactApi.newcontact_request=SendX::ContactRequest.new(email: "john@doe.com",first_name: "John",last_name: "Doe",company: "SendX",last_tracked_ip: "34.94.159.140",tags: ["tag_MKdhTovsTJDetCyrJmRySL"],custom_fields: {'custom_field_MKdhTovsTJDetCyrJmRySe'=>"VIP","custom_field_MKdhTovsTFDetCyrJerRySL"=>"Subscribers"},)begin# Create a contactresult=api_instance.create_contact(contact_request)presultrescueSendX::ApiError=>eputs"Error when calling ContactApi->create_contact: #{e}"end
Documentation for API Endpoints
All URIs are relative to https://api.sendx.io/api/v1/rest
ClassMethodHTTP requestDescription
SendX::CampaignApicreate_campaignPOST /campaignCreate campaign
SendX::CampaignApidelete_campaignDELETE /campaign/{identifier}Delete campaign
SendX::CampaignApiget_all_campaignsGET /campaignGet all campaigns
SendX::CampaignApiget_campaignGET /campaign/{identifier}Get campaign by ID
SendX::ContactApicreate_contactPOST /contactCreate a new contact
SendX::ContactApidelete_contactDELETE /contact/{identifier}Delete contact
SendX::ContactApiget_all_contactsGET /contactGet all contacts
SendX::ContactApiget_contactGET /contact/{identifier}Get contact by ID
SendX::ContactApiunsubscribe_contactPOST /contact/unsubscribe/{identifier}Unsubscribe contact
SendX::ContactApiupdate_contactPUT /contact/{identifier}Update contact
SendX::CustomFieldApicreate_custom_fieldPOST /customfieldCreate custom field
SendX::CustomFieldApidelete_custom_fieldDELETE /customfield/{identifier}Delete custom field
SendX::CustomFieldApiget_all_custom_fieldsGET /customfieldGet all custom fields
SendX::CustomFieldApiget_custom_fieldGET /customfield/{identifier}Get custom field by ID
SendX::CustomFieldApiupdate_custom_fieldPUT /customfield/{identifier}Update custom field
SendX::EmailSendingApisend_emailPOST /send/emailSend transactional email
SendX::EmailSendingApisend_email_with_templatePOST /send/templateSend email using template
SendX::EventApievents_custom_postback_getGET /events/custom/postbackCustom Event Postback URL
SendX::EventApievents_revenue_postback_getGET /events/revenue/postbackRevenue Event Postback URL
SendX::EventsApitrack_custom_eventPOST /events/customTrack custom event
SendX::EventsApitrack_revenue_eventPOST /events/revenueTrack revenue event
SendX::ListApicreate_listPOST /listCreate list
SendX::ListApidelete_listDELETE /list/{identifier}Delete list
SendX::ListApiget_all_listsGET /listGet all lists
SendX::ListApiget_listGET /list/{identifier}Get list by ID
SendX::ListApiupdate_listPUT /list/{identifier}Update list
SendX::PostApicreate_postPOST /postCreate blog post
SendX::PostApidelete_postDELETE /post/{identifier}Delete post
SendX::PostApiget_all_postsGET /postGet all posts
SendX::PostApiget_postGET /post/{identifier}Get post by ID
SendX::PostApiupdate_postPUT /post/{identifier}Update post
SendX::PostCategoryApicreate_post_categoryPOST /post/categoryCreate post category
SendX::PostCategoryApidelete_post_categoryDELETE /post/category/{identifier}Delete post category
SendX::PostCategoryApiget_all_post_categoriesGET /post/categoryGet all post categories
SendX::PostCategoryApiget_post_categoryGET /post/category/{identifier}Get post category by ID
SendX::PostCategoryApiupdate_post_categoryPUT /post/category/{identifier}Update post category
SendX::PostTagApicreate_post_tagPOST /post/tagCreate post tag
SendX::PostTagApidelete_post_tagDELETE /post/tag/{identifier}Delete post tag
SendX::PostTagApiget_all_post_tagsGET /post/tagGet all post tags
SendX::PostTagApiget_post_tagGET /post/tag/{identifier}Get post tag by ID
SendX::PostTagApiupdate_post_tagPUT /post/tag/{identifier}Update post tag
SendX::ReportApiget_campaign_reportGET /report/campaign/{identifier}Get campaign report
SendX::SenderApicreate_senderPOST /senderCreate sender
SendX::SenderApiget_all_sendersGET /senderGet all senders
SendX::TagApicreate_tagPOST /tagCreate tag
SendX::TagApidelete_tagDELETE /tag/{identifier}Delete tag
SendX::TagApiget_all_tagsGET /tagGet all tags
SendX::TagApiget_tagGET /tag/{identifier}Get tag by ID
SendX::TagApiupdate_tagPUT /tag/{identifier}Update tag
SendX::TeamMemberApiget_all_team_membersGET /team/memberGet all team members
SendX::TeamMemberApiget_team_memberGET /team/member/{identifier}Get a team member by ID
SendX::TemplateApicreate_email_templatePOST /template/emailCreate email template
SendX::TemplateApidelete_email_templateDELETE /template/email/{identifier}Delete template
SendX::TemplateApiget_all_email_templatesGET /template/emailGet all templates
SendX::TemplateApiget_email_templateGET /template/email/{identifier}Get template by ID
SendX::TemplateApiupdate_email_templatePUT /template/email/{identifier}Update template
SendX::TrackingApiidentify_contactPOST /contact/identifyIdentify contact
SendX::TrackingApitrack_contactPOST /contact/trackTrack contact
SendX::WebhookApicreate_webhookPOST /webhookCreate webhook
SendX::WebhookApidelete_webhookDELETE /webhook/{identifier}Delete webhook
SendX::WebhookApiget_all_webhooksGET /webhookGet all webhooks
SendX::WebhookApiget_webhookGET /webhook/{identifier}Get webhook by ID
SendX::WebhookApiupdate_webhookPUT /webhook/{identifier}Update webhook
Documentation for Models
Documentation for Authorization
Authentication schemes defined for the API:
TeamApiKey
  • Type: API key
  • API key parameter name: X-Team-ApiKey
  • Location: HTTP header
About
No description, website, or topics provided.
Resources
Readme
MIT license
Activity
Custom properties
Stars
0 stars
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
BranchesTags
Repository files navigation
SendX Ruby SDK
SendX REST API Documentation
🚀 Introduction
The SendX API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Key Features:
  • 🔒 Security: Team-based authentication with optional member-level access
  • 🎯 Resource-Oriented: RESTful design with clear resource boundaries
  • 📊 Rich Data Models: Three-layer model system (Input/Output/Internal)
  • 🔗 Relationships: Automatic prefix handling for resource relationships
  • 📈 Scalable: Built for high-volume email marketing operations
🏗️ Architecture Overview
SendX uses a three-layer model architecture:
  1. Input Models (RestE*): For API requests
  2. Output Models (RestR*): For API responses with prefixed IDs
  3. Internal Models: Core business logic (not exposed in API)
🔐 Security & Authentication
SendX uses API key authentication:
Team API Key
X-Team-ApiKey: YOUR_TEAM_API_KEY
  • Required for all requests
  • Team-level access to resources
  • Available in SendX Settings → Team API Key
🆔 Encrypted ID System
SendX uses encrypted IDs for security and better developer experience:
  • Internal IDs: Sequential integers (not exposed)
  • Encrypted IDs: 22-character alphanumeric strings
  • Prefixed IDs: Resource-type prefixes in API responses (contact_<22-char-id>)
ID Format
All resource IDs follow this pattern:
<resource_prefix>_<22_character_alphanumeric_string>

Example:
{
"id": "contact_BnKjkbBBS500CoBCP0oChQ",
"lists": ["list_OcuxJHdiAvujmwQVJfd3ss", "list_0tOFLp5RgV7s3LNiHrjGYs"],
"tags": ["tag_UhsDkjL772Qbj5lWtT62VK", "tag_fL7t9lsnZ9swvx2HrtQ9wM"]
}
📚 Resource Prefixes
ResourcePrefixExample
Contactcontact_contact_BnKjkbBBS500CoBCP0oChQ
Campaigncampaign_campaign_LUE9BTxmksSmqHWbh96zsn
Listlist_list_OcuxJHdiAvujmwQVJfd3ss
Tagtag_tag_UhsDkjL772Qbj5lWtT62VK
Sendersender_sender_4vK3WFhMgvOwUNyaL4QxCD
Templatetemplate_template_f3lJvTEhSjKGVb5Lwc5SWS
Custom Fieldfield_field_MnuqBAG2NPLm7PZMWbjQxt
Webhookwebhook_webhook_9l154iiXlZoPo7vngmamee
Postpost_post_XyZ123aBc456DeF789GhI
Post Categorypost_category_post_category_YzS1wOU20yw87UUHKxMzwn
Post Tagpost_tag_post_tag_123XyZ456AbC
Membermember_member_JkL012MnO345PqR678
🎯 Best Practices
Error Handling
  • Always check status codes: 2xx = success, 4xx = client error, 5xx = server error
  • Read error messages: Descriptive messages help debug issues
  • Handle rate limits: Respect API rate limits for optimal performance
Data Validation
  • Email format: Must be valid email addresses
  • Required fields: Check documentation for mandatory fields
  • Field lengths: Respect maximum length constraints
Performance
  • Pagination: Use offset/limit for large datasets
  • Batch operations: Process multiple items when supported
  • Caching: Cache responses when appropriate
🛠️ SDKs & Integration
Official SDKs available for:
📞 Support
Need help? Contact us:
  • 💬 Website Chat: Available on sendx.io
  • 📧 Email: hello@sendx.io
  • 📚 Documentation: Full guides at help.sendx.io
API Endpoint:https://api.sendx.io/api/v1/rest
Installation
To install the gem:
Install via command line
gem install sendx-ruby-sdk

Install via Gemfile
source "https://rubygems.pkg.github.com/sendx" do
gem "sendx-ruby-sdk", "1.1.0"
end

Getting Started
Please follow the installation procedure and then run the following code:
# Load the gemrequire'sendx-ruby-sdk'# Setup authorizationSendX.configuredo |config|
# Configure API key authorization: TeamApiKeyconfig.api_key['X-Team-ApiKey']='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['X-Team-ApiKey'] = 'Bearer'endapi_instance=SendX::ContactApi.newcontact_request=SendX::ContactRequest.new(email: "john@doe.com",first_name: "John",last_name: "Doe",company: "SendX",last_tracked_ip: "34.94.159.140",tags: ["tag_MKdhTovsTJDetCyrJmRySL"],custom_fields: {'custom_field_MKdhTovsTJDetCyrJmRySe'=>"VIP","custom_field_MKdhTovsTFDetCyrJerRySL"=>"Subscribers"},)begin# Create a contactresult=api_instance.create_contact(contact_request)presultrescueSendX::ApiError=>eputs"Error when calling ContactApi->create_contact: #{e}"end
Documentation for API Endpoints
All URIs are relative to https://api.sendx.io/api/v1/rest
ClassMethodHTTP requestDescription
SendX::CampaignApicreate_campaignPOST /campaignCreate campaign
SendX::CampaignApidelete_campaignDELETE /campaign/{identifier}Delete campaign
SendX::CampaignApiget_all_campaignsGET /campaignGet all campaigns
SendX::CampaignApiget_campaignGET /campaign/{identifier}Get campaign by ID
SendX::ContactApicreate_contactPOST /contactCreate a new contact
SendX::ContactApidelete_contactDELETE /contact/{identifier}Delete contact
SendX::ContactApiget_all_contactsGET /contactGet all contacts
SendX::ContactApiget_contactGET /contact/{identifier}Get contact by ID
SendX::ContactApiunsubscribe_contactPOST /contact/unsubscribe/{identifier}Unsubscribe contact
SendX::ContactApiupdate_contactPUT /contact/{identifier}Update contact
SendX::CustomFieldApicreate_custom_fieldPOST /customfieldCreate custom field
SendX::CustomFieldApidelete_custom_fieldDELETE /customfield/{identifier}Delete custom field
SendX::CustomFieldApiget_all_custom_fieldsGET /customfieldGet all custom fields
SendX::CustomFieldApiget_custom_fieldGET /customfield/{identifier}Get custom field by ID
SendX::CustomFieldApiupdate_custom_fieldPUT /customfield/{identifier}Update custom field
SendX::EmailSendingApisend_emailPOST /send/emailSend transactional email
SendX::EmailSendingApisend_email_with_templatePOST /send/templateSend email using template
SendX::EventApievents_custom_postback_getGET /events/custom/postbackCustom Event Postback URL
SendX::EventApievents_revenue_postback_getGET /events/revenue/postbackRevenue Event Postback URL
SendX::EventsApitrack_custom_eventPOST /events/customTrack custom event
SendX::EventsApitrack_revenue_eventPOST /events/revenueTrack revenue event
SendX::ListApicreate_listPOST /listCreate list
SendX::ListApidelete_listDELETE /list/{identifier}Delete list
SendX::ListApiget_all_listsGET /listGet all lists
SendX::ListApiget_listGET /list/{identifier}Get list by ID
SendX::ListApiupdate_listPUT /list/{identifier}Update list
SendX::PostApicreate_postPOST /postCreate blog post
SendX::PostApidelete_postDELETE /post/{identifier}Delete post
SendX::PostApiget_all_postsGET /postGet all posts
SendX::PostApiget_postGET /post/{identifier}Get post by ID
SendX::PostApiupdate_postPUT /post/{identifier}Update post
SendX::PostCategoryApicreate_post_categoryPOST /post/categoryCreate post category
SendX::PostCategoryApidelete_post_categoryDELETE /post/category/{identifier}Delete post category
SendX::PostCategoryApiget_all_post_categoriesGET /post/categoryGet all post categories
SendX::PostCategoryApiget_post_categoryGET /post/category/{identifier}Get post category by ID
SendX::PostCategoryApiupdate_post_categoryPUT /post/category/{identifier}Update post category
SendX::PostTagApicreate_post_tagPOST /post/tagCreate post tag
SendX::PostTagApidelete_post_tagDELETE /post/tag/{identifier}Delete post tag
SendX::PostTagApiget_all_post_tagsGET /post/tagGet all post tags
SendX::PostTagApiget_post_tagGET /post/tag/{identifier}Get post tag by ID
SendX::PostTagApiupdate_post_tagPUT /post/tag/{identifier}Update post tag
SendX::ReportApiget_campaign_reportGET /report/campaign/{identifier}Get campaign report
SendX::SenderApicreate_senderPOST /senderCreate sender
SendX::SenderApiget_all_sendersGET /senderGet all senders
SendX::TagApicreate_tagPOST /tagCreate tag
SendX::TagApidelete_tagDELETE /tag/{identifier}Delete tag
SendX::TagApiget_all_tagsGET /tagGet all tags
SendX::TagApiget_tagGET /tag/{identifier}Get tag by ID
SendX::TagApiupdate_tagPUT /tag/{identifier}Update tag
SendX::TeamMemberApiget_all_team_membersGET /team/memberGet all team members
SendX::TeamMemberApiget_team_memberGET /team/member/{identifier}Get a team member by ID
SendX::TemplateApicreate_email_templatePOST /template/emailCreate email template
SendX::TemplateApidelete_email_templateDELETE /template/email/{identifier}Delete template
SendX::TemplateApiget_all_email_templatesGET /template/emailGet all templates
SendX::TemplateApiget_email_templateGET /template/email/{identifier}Get template by ID
SendX::TemplateApiupdate_email_templatePUT /template/email/{identifier}Update template
SendX::TrackingApiidentify_contactPOST /contact/identifyIdentify contact
SendX::TrackingApitrack_contactPOST /contact/trackTrack contact
SendX::WebhookApicreate_webhookPOST /webhookCreate webhook
SendX::WebhookApidelete_webhookDELETE /webhook/{identifier}Delete webhook
SendX::WebhookApiget_all_webhooksGET /webhookGet all webhooks
SendX::WebhookApiget_webhookGET /webhook/{identifier}Get webhook by ID
SendX::WebhookApiupdate_webhookPUT /webhook/{identifier}Update webhook
Documentation for Models
Documentation for Authorization
Authentication schemes defined for the API:
TeamApiKey
  • Type: API key
  • API key parameter name: X-Team-ApiKey
  • Location: HTTP header
About
No description, website, or topics provided.
Resources
Readme
MIT license
Activity
Custom properties
Stars
0 stars
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
BranchesTags
Repository files navigation
SendX Ruby SDK
SendX REST API Documentation
🚀 Introduction
The SendX API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Key Features:
  • 🔒 Security: Team-based authentication with optional member-level access
  • 🎯 Resource-Oriented: RESTful design with clear resource boundaries
  • 📊 Rich Data Models: Three-layer model system (Input/Output/Internal)
  • 🔗 Relationships: Automatic prefix handling for resource relationships
  • 📈 Scalable: Built for high-volume email marketing operations
🏗️ Architecture Overview
SendX uses a three-layer model architecture:
  1. Input Models (RestE*): For API requests
  2. Output Models (RestR*): For API responses with prefixed IDs
  3. Internal Models: Core business logic (not exposed in API)
🔐 Security & Authentication
SendX uses API key authentication:
Team API Key
X-Team-ApiKey: YOUR_TEAM_API_KEY
  • Required for all requests
  • Team-level access to resources
  • Available in SendX Settings → Team API Key
🆔 Encrypted ID System
SendX uses encrypted IDs for security and better developer experience:
  • Internal IDs: Sequential integers (not exposed)
  • Encrypted IDs: 22-character alphanumeric strings
  • Prefixed IDs: Resource-type prefixes in API responses (contact_<22-char-id>)
ID Format
All resource IDs follow this pattern:
<resource_prefix>_<22_character_alphanumeric_string>

Example:
{
"id": "contact_BnKjkbBBS500CoBCP0oChQ",
"lists": ["list_OcuxJHdiAvujmwQVJfd3ss", "list_0tOFLp5RgV7s3LNiHrjGYs"],
"tags": ["tag_UhsDkjL772Qbj5lWtT62VK", "tag_fL7t9lsnZ9swvx2HrtQ9wM"]
}
📚 Resource Prefixes
ResourcePrefixExample
Contactcontact_contact_BnKjkbBBS500CoBCP0oChQ
Campaigncampaign_campaign_LUE9BTxmksSmqHWbh96zsn
Listlist_list_OcuxJHdiAvujmwQVJfd3ss
Tagtag_tag_UhsDkjL772Qbj5lWtT62VK
Sendersender_sender_4vK3WFhMgvOwUNyaL4QxCD
Templatetemplate_template_f3lJvTEhSjKGVb5Lwc5SWS
Custom Fieldfield_field_MnuqBAG2NPLm7PZMWbjQxt
Webhookwebhook_webhook_9l154iiXlZoPo7vngmamee
Postpost_post_XyZ123aBc456DeF789GhI
Post Categorypost_category_post_category_YzS1wOU20yw87UUHKxMzwn
Post Tagpost_tag_post_tag_123XyZ456AbC
Membermember_member_JkL012MnO345PqR678
🎯 Best Practices
Error Handling
  • Always check status codes: 2xx = success, 4xx = client error, 5xx = server error
  • Read error messages: Descriptive messages help debug issues
  • Handle rate limits: Respect API rate limits for optimal performance
Data Validation
  • Email format: Must be valid email addresses
  • Required fields: Check documentation for mandatory fields
  • Field lengths: Respect maximum length constraints
Performance
  • Pagination: Use offset/limit for large datasets
  • Batch operations: Process multiple items when supported
  • Caching: Cache responses when appropriate
🛠️ SDKs & Integration
Official SDKs available for:
📞 Support
Need help? Contact us:
  • 💬 Website Chat: Available on sendx.io
  • 📧 Email: hello@sendx.io
  • 📚 Documentation: Full guides at help.sendx.io
API Endpoint:https://api.sendx.io/api/v1/rest
Installation
To install the gem:
Install via command line
gem install sendx-ruby-sdk

Install via Gemfile
source "https://rubygems.pkg.github.com/sendx" do
gem "sendx-ruby-sdk", "1.1.0"
end

Getting Started
Please follow the installation procedure and then run the following code:
# Load the gemrequire'sendx-ruby-sdk'# Setup authorizationSendX.configuredo |config|
# Configure API key authorization: TeamApiKeyconfig.api_key['X-Team-ApiKey']='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['X-Team-ApiKey'] = 'Bearer'endapi_instance=SendX::ContactApi.newcontact_request=SendX::ContactRequest.new(email: "john@doe.com",first_name: "John",last_name: "Doe",company: "SendX",last_tracked_ip: "34.94.159.140",tags: ["tag_MKdhTovsTJDetCyrJmRySL"],custom_fields: {'custom_field_MKdhTovsTJDetCyrJmRySe'=>"VIP","custom_field_MKdhTovsTFDetCyrJerRySL"=>"Subscribers"},)begin# Create a contactresult=api_instance.create_contact(contact_request)presultrescueSendX::ApiError=>eputs"Error when calling ContactApi->create_contact: #{e}"end
Documentation for API Endpoints
All URIs are relative to https://api.sendx.io/api/v1/rest
ClassMethodHTTP requestDescription
SendX::CampaignApicreate_campaignPOST /campaignCreate campaign
SendX::CampaignApidelete_campaignDELETE /campaign/{identifier}Delete campaign
SendX::CampaignApiget_all_campaignsGET /campaignGet all campaigns
SendX::CampaignApiget_campaignGET /campaign/{identifier}Get campaign by ID
SendX::ContactApicreate_contactPOST /contactCreate a new contact
SendX::ContactApidelete_contactDELETE /contact/{identifier}Delete contact
SendX::ContactApiget_all_contactsGET /contactGet all contacts
SendX::ContactApiget_contactGET /contact/{identifier}Get contact by ID
SendX::ContactApiunsubscribe_contactPOST /contact/unsubscribe/{identifier}Unsubscribe contact
SendX::ContactApiupdate_contactPUT /contact/{identifier}Update contact
SendX::CustomFieldApicreate_custom_fieldPOST /customfieldCreate custom field
SendX::CustomFieldApidelete_custom_fieldDELETE /customfield/{identifier}Delete custom field
SendX::CustomFieldApiget_all_custom_fieldsGET /customfieldGet all custom fields
SendX::CustomFieldApiget_custom_fieldGET /customfield/{identifier}Get custom field by ID
SendX::CustomFieldApiupdate_custom_fieldPUT /customfield/{identifier}Update custom field
SendX::EmailSendingApisend_emailPOST /send/emailSend transactional email
SendX::EmailSendingApisend_email_with_templatePOST /send/templateSend email using template
SendX::EventApievents_custom_postback_getGET /events/custom/postbackCustom Event Postback URL
SendX::EventApievents_revenue_postback_getGET /events/revenue/postbackRevenue Event Postback URL
SendX::EventsApitrack_custom_eventPOST /events/customTrack custom event
SendX::EventsApitrack_revenue_eventPOST /events/revenueTrack revenue event
SendX::ListApicreate_listPOST /listCreate list
SendX::ListApidelete_listDELETE /list/{identifier}Delete list
SendX::ListApiget_all_listsGET /listGet all lists
SendX::ListApiget_listGET /list/{identifier}Get list by ID
SendX::ListApiupdate_listPUT /list/{identifier}Update list
SendX::PostApicreate_postPOST /postCreate blog post
SendX::PostApidelete_postDELETE /post/{identifier}Delete post
SendX::PostApiget_all_postsGET /postGet all posts
SendX::PostApiget_postGET /post/{identifier}Get post by ID
SendX::PostApiupdate_postPUT /post/{identifier}Update post
SendX::PostCategoryApicreate_post_categoryPOST /post/categoryCreate post category
SendX::PostCategoryApidelete_post_categoryDELETE /post/category/{identifier}Delete post category
SendX::PostCategoryApiget_all_post_categoriesGET /post/categoryGet all post categories
SendX::PostCategoryApiget_post_categoryGET /post/category/{identifier}Get post category by ID
SendX::PostCategoryApiupdate_post_categoryPUT /post/category/{identifier}Update post category
SendX::PostTagApicreate_post_tagPOST /post/tagCreate post tag
SendX::PostTagApidelete_post_tagDELETE /post/tag/{identifier}Delete post tag
SendX::PostTagApiget_all_post_tagsGET /post/tagGet all post tags
SendX::PostTagApiget_post_tagGET /post/tag/{identifier}Get post tag by ID
SendX::PostTagApiupdate_post_tagPUT /post/tag/{identifier}Update post tag
SendX::ReportApiget_campaign_reportGET /report/campaign/{identifier}Get campaign report
SendX::SenderApicreate_senderPOST /senderCreate sender
SendX::SenderApiget_all_sendersGET /senderGet all senders
SendX::TagApicreate_tagPOST /tagCreate tag
SendX::TagApidelete_tagDELETE /tag/{identifier}Delete tag
SendX::TagApiget_all_tagsGET /tagGet all tags
SendX::TagApiget_tagGET /tag/{identifier}Get tag by ID
SendX::TagApiupdate_tagPUT /tag/{identifier}Update tag
SendX::TeamMemberApiget_all_team_membersGET /team/memberGet all team members
SendX::TeamMemberApiget_team_memberGET /team/member/{identifier}Get a team member by ID
SendX::TemplateApicreate_email_templatePOST /template/emailCreate email template
SendX::TemplateApidelete_email_templateDELETE /template/email/{identifier}Delete template
SendX::TemplateApiget_all_email_templatesGET /template/emailGet all templates
SendX::TemplateApiget_email_templateGET /template/email/{identifier}Get template by ID
SendX::TemplateApiupdate_email_templatePUT /template/email/{identifier}Update template
SendX::TrackingApiidentify_contactPOST /contact/identifyIdentify contact
SendX::TrackingApitrack_contactPOST /contact/trackTrack contact
SendX::WebhookApicreate_webhookPOST /webhookCreate webhook
SendX::WebhookApidelete_webhookDELETE /webhook/{identifier}Delete webhook
SendX::WebhookApiget_all_webhooksGET /webhookGet all webhooks
SendX::WebhookApiget_webhookGET /webhook/{identifier}Get webhook by ID
SendX::WebhookApiupdate_webhookPUT /webhook/{identifier}Update webhook
Documentation for Models
Documentation for Authorization
Authentication schemes defined for the API:
TeamApiKey
  • Type: API key
  • API key parameter name: X-Team-ApiKey
  • Location: HTTP header
About
No description, website, or topics provided.
Resources
Readme
MIT license
Activity
Custom properties
Stars
0 stars
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
BranchesTags
Repository files navigation
SendX Ruby SDK
SendX REST API Documentation
🚀 Introduction
The SendX API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Key Features:
  • 🔒 Security: Team-based authentication with optional member-level access
  • 🎯 Resource-Oriented: RESTful design with clear resource boundaries
  • 📊 Rich Data Models: Three-layer model system (Input/Output/Internal)
  • 🔗 Relationships: Automatic prefix handling for resource relationships
  • 📈 Scalable: Built for high-volume email marketing operations
🏗️ Architecture Overview
SendX uses a three-layer model architecture:
  1. Input Models (RestE*): For API requests
  2. Output Models (RestR*): For API responses with prefixed IDs
  3. Internal Models: Core business logic (not exposed in API)
🔐 Security & Authentication
SendX uses API key authentication:
Team API Key
X-Team-ApiKey: YOUR_TEAM_API_KEY
  • Required for all requests
  • Team-level access to resources
  • Available in SendX Settings → Team API Key
🆔 Encrypted ID System
SendX uses encrypted IDs for security and better developer experience:
  • Internal IDs: Sequential integers (not exposed)
  • Encrypted IDs: 22-character alphanumeric strings
  • Prefixed IDs: Resource-type prefixes in API responses (contact_<22-char-id>)
ID Format
All resource IDs follow this pattern:
<resource_prefix>_<22_character_alphanumeric_string>

Example:
{
"id": "contact_BnKjkbBBS500CoBCP0oChQ",
"lists": ["list_OcuxJHdiAvujmwQVJfd3ss", "list_0tOFLp5RgV7s3LNiHrjGYs"],
"tags": ["tag_UhsDkjL772Qbj5lWtT62VK", "tag_fL7t9lsnZ9swvx2HrtQ9wM"]
}
📚 Resource Prefixes
ResourcePrefixExample
Contactcontact_contact_BnKjkbBBS500CoBCP0oChQ
Campaigncampaign_campaign_LUE9BTxmksSmqHWbh96zsn
Listlist_list_OcuxJHdiAvujmwQVJfd3ss
Tagtag_tag_UhsDkjL772Qbj5lWtT62VK
Sendersender_sender_4vK3WFhMgvOwUNyaL4QxCD
Templatetemplate_template_f3lJvTEhSjKGVb5Lwc5SWS
Custom Fieldfield_field_MnuqBAG2NPLm7PZMWbjQxt
Webhookwebhook_webhook_9l154iiXlZoPo7vngmamee
Postpost_post_XyZ123aBc456DeF789GhI
Post Categorypost_category_post_category_YzS1wOU20yw87UUHKxMzwn
Post Tagpost_tag_post_tag_123XyZ456AbC
Membermember_member_JkL012MnO345PqR678
🎯 Best Practices
Error Handling
  • Always check status codes: 2xx = success, 4xx = client error, 5xx = server error
  • Read error messages: Descriptive messages help debug issues
  • Handle rate limits: Respect API rate limits for optimal performance
Data Validation
  • Email format: Must be valid email addresses
  • Required fields: Check documentation for mandatory fields
  • Field lengths: Respect maximum length constraints
Performance
  • Pagination: Use offset/limit for large datasets
  • Batch operations: Process multiple items when supported
  • Caching: Cache responses when appropriate
🛠️ SDKs & Integration
Official SDKs available for:
📞 Support
Need help? Contact us:
  • 💬 Website Chat: Available on sendx.io
  • 📧 Email: hello@sendx.io
  • 📚 Documentation: Full guides at help.sendx.io
API Endpoint:https://api.sendx.io/api/v1/rest
Installation
To install the gem:
Install via command line
gem install sendx-ruby-sdk

Install via Gemfile
source "https://rubygems.pkg.github.com/sendx" do
gem "sendx-ruby-sdk", "1.1.0"
end

Getting Started
Please follow the installation procedure and then run the following code:
# Load the gemrequire'sendx-ruby-sdk'# Setup authorizationSendX.configuredo |config|
# Configure API key authorization: TeamApiKeyconfig.api_key['X-Team-ApiKey']='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['X-Team-ApiKey'] = 'Bearer'endapi_instance=SendX::ContactApi.newcontact_request=SendX::ContactRequest.new(email: "john@doe.com",first_name: "John",last_name: "Doe",company: "SendX",last_tracked_ip: "34.94.159.140",tags: ["tag_MKdhTovsTJDetCyrJmRySL"],custom_fields: {'custom_field_MKdhTovsTJDetCyrJmRySe'=>"VIP","custom_field_MKdhTovsTFDetCyrJerRySL"=>"Subscribers"},)begin# Create a contactresult=api_instance.create_contact(contact_request)presultrescueSendX::ApiError=>eputs"Error when calling ContactApi->create_contact: #{e}"end
Documentation for API Endpoints
All URIs are relative to https://api.sendx.io/api/v1/rest
ClassMethodHTTP requestDescription
SendX::CampaignApicreate_campaignPOST /campaignCreate campaign
SendX::CampaignApidelete_campaignDELETE /campaign/{identifier}Delete campaign
SendX::CampaignApiget_all_campaignsGET /campaignGet all campaigns
SendX::CampaignApiget_campaignGET /campaign/{identifier}Get campaign by ID
SendX::ContactApicreate_contactPOST /contactCreate a new contact
SendX::ContactApidelete_contactDELETE /contact/{identifier}Delete contact
SendX::ContactApiget_all_contactsGET /contactGet all contacts
SendX::ContactApiget_contactGET /contact/{identifier}Get contact by ID
SendX::ContactApiunsubscribe_contactPOST /contact/unsubscribe/{identifier}Unsubscribe contact
SendX::ContactApiupdate_contactPUT /contact/{identifier}Update contact
SendX::CustomFieldApicreate_custom_fieldPOST /customfieldCreate custom field
SendX::CustomFieldApidelete_custom_fieldDELETE /customfield/{identifier}Delete custom field
SendX::CustomFieldApiget_all_custom_fieldsGET /customfieldGet all custom fields
SendX::CustomFieldApiget_custom_fieldGET /customfield/{identifier}Get custom field by ID
SendX::CustomFieldApiupdate_custom_fieldPUT /customfield/{identifier}Update custom field
SendX::EmailSendingApisend_emailPOST /send/emailSend transactional email
SendX::EmailSendingApisend_email_with_templatePOST /send/templateSend email using template
SendX::EventApievents_custom_postback_getGET /events/custom/postbackCustom Event Postback URL
SendX::EventApievents_revenue_postback_getGET /events/revenue/postbackRevenue Event Postback URL
SendX::EventsApitrack_custom_eventPOST /events/customTrack custom event
SendX::EventsApitrack_revenue_eventPOST /events/revenueTrack revenue event
SendX::ListApicreate_listPOST /listCreate list
SendX::ListApidelete_listDELETE /list/{identifier}Delete list
SendX::ListApiget_all_listsGET /listGet all lists
SendX::ListApiget_listGET /list/{identifier}Get list by ID
SendX::ListApiupdate_listPUT /list/{identifier}Update list
SendX::PostApicreate_postPOST /postCreate blog post
SendX::PostApidelete_postDELETE /post/{identifier}Delete post
SendX::PostApiget_all_postsGET /postGet all posts
SendX::PostApiget_postGET /post/{identifier}Get post by ID
SendX::PostApiupdate_postPUT /post/{identifier}Update post
SendX::PostCategoryApicreate_post_categoryPOST /post/categoryCreate post category
SendX::PostCategoryApidelete_post_categoryDELETE /post/category/{identifier}Delete post category
SendX::PostCategoryApiget_all_post_categoriesGET /post/categoryGet all post categories
SendX::PostCategoryApiget_post_categoryGET /post/category/{identifier}Get post category by ID
SendX::PostCategoryApiupdate_post_categoryPUT /post/category/{identifier}Update post category
SendX::PostTagApicreate_post_tagPOST /post/tagCreate post tag
SendX::PostTagApidelete_post_tagDELETE /post/tag/{identifier}Delete post tag
SendX::PostTagApiget_all_post_tagsGET /post/tagGet all post tags
SendX::PostTagApiget_post_tagGET /post/tag/{identifier}Get post tag by ID
SendX::PostTagApiupdate_post_tagPUT /post/tag/{identifier}Update post tag
SendX::ReportApiget_campaign_reportGET /report/campaign/{identifier}Get campaign report
SendX::SenderApicreate_senderPOST /senderCreate sender
SendX::SenderApiget_all_sendersGET /senderGet all senders
SendX::TagApicreate_tagPOST /tagCreate tag
SendX::TagApidelete_tagDELETE /tag/{identifier}Delete tag
SendX::TagApiget_all_tagsGET /tagGet all tags
SendX::TagApiget_tagGET /tag/{identifier}Get tag by ID
SendX::TagApiupdate_tagPUT /tag/{identifier}Update tag
SendX::TeamMemberApiget_all_team_membersGET /team/memberGet all team members
SendX::TeamMemberApiget_team_memberGET /team/member/{identifier}Get a team member by ID
SendX::TemplateApicreate_email_templatePOST /template/emailCreate email template
SendX::TemplateApidelete_email_templateDELETE /template/email/{identifier}Delete template
SendX::TemplateApiget_all_email_templatesGET /template/emailGet all templates
SendX::TemplateApiget_email_templateGET /template/email/{identifier}Get template by ID
SendX::TemplateApiupdate_email_templatePUT /template/email/{identifier}Update template
SendX::TrackingApiidentify_contactPOST /contact/identifyIdentify contact
SendX::TrackingApitrack_contactPOST /contact/trackTrack contact
SendX::WebhookApicreate_webhookPOST /webhookCreate webhook
SendX::WebhookApidelete_webhookDELETE /webhook/{identifier}Delete webhook
SendX::WebhookApiget_all_webhooksGET /webhookGet all webhooks
SendX::WebhookApiget_webhookGET /webhook/{identifier}Get webhook by ID
SendX::WebhookApiupdate_webhookPUT /webhook/{identifier}Update webhook
Documentation for Models
Documentation for Authorization
Authentication schemes defined for the API:
TeamApiKey
  • Type: API key
  • API key parameter name: X-Team-ApiKey
  • Location: HTTP header
About
No description, website, or topics provided.
Resources
Readme
MIT license
Activity
Custom properties
Stars
0 stars
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
BranchesTags
Repository files navigation
SendX Ruby SDK
SendX REST API Documentation
🚀 Introduction
The SendX API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Key Features:
  • 🔒 Security: Team-based authentication with optional member-level access
  • 🎯 Resource-Oriented: RESTful design with clear resource boundaries
  • 📊 Rich Data Models: Three-layer model system (Input/Output/Internal)
  • 🔗 Relationships: Automatic prefix handling for resource relationships
  • 📈 Scalable: Built for high-volume email marketing operations
🏗️ Architecture Overview
SendX uses a three-layer model architecture:
  1. Input Models (RestE*): For API requests
  2. Output Models (RestR*): For API responses with prefixed IDs
  3. Internal Models: Core business logic (not exposed in API)
🔐 Security & Authentication
SendX uses API key authentication:
Team API Key
X-Team-ApiKey: YOUR_TEAM_API_KEY
  • Required for all requests
  • Team-level access to resources
  • Available in SendX Settings → Team API Key
🆔 Encrypted ID System
SendX uses encrypted IDs for security and better developer experience:
  • Internal IDs: Sequential integers (not exposed)
  • Encrypted IDs: 22-character alphanumeric strings
  • Prefixed IDs: Resource-type prefixes in API responses (contact_<22-char-id>)
ID Format
All resource IDs follow this pattern:
<resource_prefix>_<22_character_alphanumeric_string>

Example:
{
"id": "contact_BnKjkbBBS500CoBCP0oChQ",
"lists": ["list_OcuxJHdiAvujmwQVJfd3ss", "list_0tOFLp5RgV7s3LNiHrjGYs"],
"tags": ["tag_UhsDkjL772Qbj5lWtT62VK", "tag_fL7t9lsnZ9swvx2HrtQ9wM"]
}
📚 Resource Prefixes
ResourcePrefixExample
Contactcontact_contact_BnKjkbBBS500CoBCP0oChQ
Campaigncampaign_campaign_LUE9BTxmksSmqHWbh96zsn
Listlist_list_OcuxJHdiAvujmwQVJfd3ss
Tagtag_tag_UhsDkjL772Qbj5lWtT62VK
Sendersender_sender_4vK3WFhMgvOwUNyaL4QxCD
Templatetemplate_template_f3lJvTEhSjKGVb5Lwc5SWS
Custom Fieldfield_field_MnuqBAG2NPLm7PZMWbjQxt
Webhookwebhook_webhook_9l154iiXlZoPo7vngmamee
Postpost_post_XyZ123aBc456DeF789GhI
Post Categorypost_category_post_category_YzS1wOU20yw87UUHKxMzwn
Post Tagpost_tag_post_tag_123XyZ456AbC
Membermember_member_JkL012MnO345PqR678
🎯 Best Practices
Error Handling
  • Always check status codes: 2xx = success, 4xx = client error, 5xx = server error
  • Read error messages: Descriptive messages help debug issues
  • Handle rate limits: Respect API rate limits for optimal performance
Data Validation
  • Email format: Must be valid email addresses
  • Required fields: Check documentation for mandatory fields
  • Field lengths: Respect maximum length constraints
Performance
  • Pagination: Use offset/limit for large datasets
  • Batch operations: Process multiple items when supported
  • Caching: Cache responses when appropriate
🛠️ SDKs & Integration
Official SDKs available for:
📞 Support
Need help? Contact us:
  • 💬 Website Chat: Available on sendx.io
  • 📧 Email: hello@sendx.io
  • 📚 Documentation: Full guides at help.sendx.io
API Endpoint:https://api.sendx.io/api/v1/rest
Installation
To install the gem:
Install via command line
gem install sendx-ruby-sdk

Install via Gemfile
source "https://rubygems.pkg.github.com/sendx" do
gem "sendx-ruby-sdk", "1.1.0"
end

Getting Started
Please follow the installation procedure and then run the following code:
# Load the gemrequire'sendx-ruby-sdk'# Setup authorizationSendX.configuredo |config|
# Configure API key authorization: TeamApiKeyconfig.api_key['X-Team-ApiKey']='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['X-Team-ApiKey'] = 'Bearer'endapi_instance=SendX::ContactApi.newcontact_request=SendX::ContactRequest.new(email: "john@doe.com",first_name: "John",last_name: "Doe",company: "SendX",last_tracked_ip: "34.94.159.140",tags: ["tag_MKdhTovsTJDetCyrJmRySL"],custom_fields: {'custom_field_MKdhTovsTJDetCyrJmRySe'=>"VIP","custom_field_MKdhTovsTFDetCyrJerRySL"=>"Subscribers"},)begin# Create a contactresult=api_instance.create_contact(contact_request)presultrescueSendX::ApiError=>eputs"Error when calling ContactApi->create_contact: #{e}"end
Documentation for API Endpoints
All URIs are relative to https://api.sendx.io/api/v1/rest
ClassMethodHTTP requestDescription
SendX::CampaignApicreate_campaignPOST /campaignCreate campaign
SendX::CampaignApidelete_campaignDELETE /campaign/{identifier}Delete campaign
SendX::CampaignApiget_all_campaignsGET /campaignGet all campaigns
SendX::CampaignApiget_campaignGET /campaign/{identifier}Get campaign by ID
SendX::ContactApicreate_contactPOST /contactCreate a new contact
SendX::ContactApidelete_contactDELETE /contact/{identifier}Delete contact
SendX::ContactApiget_all_contactsGET /contactGet all contacts
SendX::ContactApiget_contactGET /contact/{identifier}Get contact by ID
SendX::ContactApiunsubscribe_contactPOST /contact/unsubscribe/{identifier}Unsubscribe contact
SendX::ContactApiupdate_contactPUT /contact/{identifier}Update contact
SendX::CustomFieldApicreate_custom_fieldPOST /customfieldCreate custom field
SendX::CustomFieldApidelete_custom_fieldDELETE /customfield/{identifier}Delete custom field
SendX::CustomFieldApiget_all_custom_fieldsGET /customfieldGet all custom fields
SendX::CustomFieldApiget_custom_fieldGET /customfield/{identifier}Get custom field by ID
SendX::CustomFieldApiupdate_custom_fieldPUT /customfield/{identifier}Update custom field
SendX::EmailSendingApisend_emailPOST /send/emailSend transactional email
SendX::EmailSendingApisend_email_with_templatePOST /send/templateSend email using template
SendX::EventApievents_custom_postback_getGET /events/custom/postbackCustom Event Postback URL
SendX::EventApievents_revenue_postback_getGET /events/revenue/postbackRevenue Event Postback URL
SendX::EventsApitrack_custom_eventPOST /events/customTrack custom event
SendX::EventsApitrack_revenue_eventPOST /events/revenueTrack revenue event
SendX::ListApicreate_listPOST /listCreate list
SendX::ListApidelete_listDELETE /list/{identifier}Delete list
SendX::ListApiget_all_listsGET /listGet all lists
SendX::ListApiget_listGET /list/{identifier}Get list by ID
SendX::ListApiupdate_listPUT /list/{identifier}Update list
SendX::PostApicreate_postPOST /postCreate blog post
SendX::PostApidelete_postDELETE /post/{identifier}Delete post
SendX::PostApiget_all_postsGET /postGet all posts
SendX::PostApiget_postGET /post/{identifier}Get post by ID
SendX::PostApiupdate_postPUT /post/{identifier}Update post
SendX::PostCategoryApicreate_post_categoryPOST /post/categoryCreate post category
SendX::PostCategoryApidelete_post_categoryDELETE /post/category/{identifier}Delete post category
SendX::PostCategoryApiget_all_post_categoriesGET /post/categoryGet all post categories
SendX::PostCategoryApiget_post_categoryGET /post/category/{identifier}Get post category by ID
SendX::PostCategoryApiupdate_post_categoryPUT /post/category/{identifier}Update post category
SendX::PostTagApicreate_post_tagPOST /post/tagCreate post tag
SendX::PostTagApidelete_post_tagDELETE /post/tag/{identifier}Delete post tag
SendX::PostTagApiget_all_post_tagsGET /post/tagGet all post tags
SendX::PostTagApiget_post_tagGET /post/tag/{identifier}Get post tag by ID
SendX::PostTagApiupdate_post_tagPUT /post/tag/{identifier}Update post tag
SendX::ReportApiget_campaign_reportGET /report/campaign/{identifier}Get campaign report
SendX::SenderApicreate_senderPOST /senderCreate sender
SendX::SenderApiget_all_sendersGET /senderGet all senders
SendX::TagApicreate_tagPOST /tagCreate tag
SendX::TagApidelete_tagDELETE /tag/{identifier}Delete tag
SendX::TagApiget_all_tagsGET /tagGet all tags
SendX::TagApiget_tagGET /tag/{identifier}Get tag by ID
SendX::TagApiupdate_tagPUT /tag/{identifier}Update tag
SendX::TeamMemberApiget_all_team_membersGET /team/memberGet all team members
SendX::TeamMemberApiget_team_memberGET /team/member/{identifier}Get a team member by ID
SendX::TemplateApicreate_email_templatePOST /template/emailCreate email template
SendX::TemplateApidelete_email_templateDELETE /template/email/{identifier}Delete template
SendX::TemplateApiget_all_email_templatesGET /template/emailGet all templates
SendX::TemplateApiget_email_templateGET /template/email/{identifier}Get template by ID
SendX::TemplateApiupdate_email_templatePUT /template/email/{identifier}Update template
SendX::TrackingApiidentify_contactPOST /contact/identifyIdentify contact
SendX::TrackingApitrack_contactPOST /contact/trackTrack contact
SendX::WebhookApicreate_webhookPOST /webhookCreate webhook
SendX::WebhookApidelete_webhookDELETE /webhook/{identifier}Delete webhook
SendX::WebhookApiget_all_webhooksGET /webhookGet all webhooks
SendX::WebhookApiget_webhookGET /webhook/{identifier}Get webhook by ID
SendX::WebhookApiupdate_webhookPUT /webhook/{identifier}Update webhook
Documentation for Models
Documentation for Authorization
Authentication schemes defined for the API:
TeamApiKey
  • Type: API key
  • API key parameter name: X-Team-ApiKey
  • Location: HTTP header
About
No description, website, or topics provided.
Resources
Readme
MIT license
Activity
Custom properties
Stars
0 stars
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
BranchesTags
Repository files navigation
SendX Ruby SDK
SendX REST API Documentation
🚀 Introduction
The SendX API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Key Features:
  • 🔒 Security: Team-based authentication with optional member-level access
  • 🎯 Resource-Oriented: RESTful design with clear resource boundaries
  • 📊 Rich Data Models: Three-layer model system (Input/Output/Internal)
  • 🔗 Relationships: Automatic prefix handling for resource relationships
  • 📈 Scalable: Built for high-volume email marketing operations
🏗️ Architecture Overview
SendX uses a three-layer model architecture:
  1. Input Models (RestE*): For API requests
  2. Output Models (RestR*): For API responses with prefixed IDs
  3. Internal Models: Core business logic (not exposed in API)
🔐 Security & Authentication
SendX uses API key authentication:
Team API Key
X-Team-ApiKey: YOUR_TEAM_API_KEY
  • Required for all requests
  • Team-level access to resources
  • Available in SendX Settings → Team API Key
🆔 Encrypted ID System
SendX uses encrypted IDs for security and better developer experience:
  • Internal IDs: Sequential integers (not exposed)
  • Encrypted IDs: 22-character alphanumeric strings
  • Prefixed IDs: Resource-type prefixes in API responses (contact_<22-char-id>)
ID Format
All resource IDs follow this pattern:
<resource_prefix>_<22_character_alphanumeric_string>

Example:
{
"id": "contact_BnKjkbBBS500CoBCP0oChQ",
"lists": ["list_OcuxJHdiAvujmwQVJfd3ss", "list_0tOFLp5RgV7s3LNiHrjGYs"],
"tags": ["tag_UhsDkjL772Qbj5lWtT62VK", "tag_fL7t9lsnZ9swvx2HrtQ9wM"]
}
📚 Resource Prefixes
ResourcePrefixExample
Contactcontact_contact_BnKjkbBBS500CoBCP0oChQ
Campaigncampaign_campaign_LUE9BTxmksSmqHWbh96zsn
Listlist_list_OcuxJHdiAvujmwQVJfd3ss
Tagtag_tag_UhsDkjL772Qbj5lWtT62VK
Sendersender_sender_4vK3WFhMgvOwUNyaL4QxCD
Templatetemplate_template_f3lJvTEhSjKGVb5Lwc5SWS
Custom Fieldfield_field_MnuqBAG2NPLm7PZMWbjQxt
Webhookwebhook_webhook_9l154iiXlZoPo7vngmamee
Postpost_post_XyZ123aBc456DeF789GhI
Post Categorypost_category_post_category_YzS1wOU20yw87UUHKxMzwn
Post Tagpost_tag_post_tag_123XyZ456AbC
Membermember_member_JkL012MnO345PqR678
🎯 Best Practices
Error Handling
  • Always check status codes: 2xx = success, 4xx = client error, 5xx = server error
  • Read error messages: Descriptive messages help debug issues
  • Handle rate limits: Respect API rate limits for optimal performance
Data Validation
  • Email format: Must be valid email addresses
  • Required fields: Check documentation for mandatory fields
  • Field lengths: Respect maximum length constraints
Performance
  • Pagination: Use offset/limit for large datasets
  • Batch operations: Process multiple items when supported
  • Caching: Cache responses when appropriate
🛠️ SDKs & Integration
Official SDKs available for:
📞 Support
Need help? Contact us:
  • 💬 Website Chat: Available on sendx.io
  • 📧 Email: hello@sendx.io
  • 📚 Documentation: Full guides at help.sendx.io
API Endpoint:https://api.sendx.io/api/v1/rest
Installation
To install the gem:
Install via command line
gem install sendx-ruby-sdk

Install via Gemfile
source "https://rubygems.pkg.github.com/sendx" do
gem "sendx-ruby-sdk", "1.1.0"
end

Getting Started
Please follow the installation procedure and then run the following code:
# Load the gemrequire'sendx-ruby-sdk'# Setup authorizationSendX.configuredo |config|
# Configure API key authorization: TeamApiKeyconfig.api_key['X-Team-ApiKey']='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['X-Team-ApiKey'] = 'Bearer'endapi_instance=SendX::ContactApi.newcontact_request=SendX::ContactRequest.new(email: "john@doe.com",first_name: "John",last_name: "Doe",company: "SendX",last_tracked_ip: "34.94.159.140",tags: ["tag_MKdhTovsTJDetCyrJmRySL"],custom_fields: {'custom_field_MKdhTovsTJDetCyrJmRySe'=>"VIP","custom_field_MKdhTovsTFDetCyrJerRySL"=>"Subscribers"},)begin# Create a contactresult=api_instance.create_contact(contact_request)presultrescueSendX::ApiError=>eputs"Error when calling ContactApi->create_contact: #{e}"end
Documentation for API Endpoints
All URIs are relative to https://api.sendx.io/api/v1/rest
ClassMethodHTTP requestDescription
SendX::CampaignApicreate_campaignPOST /campaignCreate campaign
SendX::CampaignApidelete_campaignDELETE /campaign/{identifier}Delete campaign
SendX::CampaignApiget_all_campaignsGET /campaignGet all campaigns
SendX::CampaignApiget_campaignGET /campaign/{identifier}Get campaign by ID
SendX::ContactApicreate_contactPOST /contactCreate a new contact
SendX::ContactApidelete_contactDELETE /contact/{identifier}Delete contact
SendX::ContactApiget_all_contactsGET /contactGet all contacts
SendX::ContactApiget_contactGET /contact/{identifier}Get contact by ID
SendX::ContactApiunsubscribe_contactPOST /contact/unsubscribe/{identifier}Unsubscribe contact
SendX::ContactApiupdate_contactPUT /contact/{identifier}Update contact
SendX::CustomFieldApicreate_custom_fieldPOST /customfieldCreate custom field
SendX::CustomFieldApidelete_custom_fieldDELETE /customfield/{identifier}Delete custom field
SendX::CustomFieldApiget_all_custom_fieldsGET /customfieldGet all custom fields
SendX::CustomFieldApiget_custom_fieldGET /customfield/{identifier}Get custom field by ID
SendX::CustomFieldApiupdate_custom_fieldPUT /customfield/{identifier}Update custom field
SendX::EmailSendingApisend_emailPOST /send/emailSend transactional email
SendX::EmailSendingApisend_email_with_templatePOST /send/templateSend email using template
SendX::EventApievents_custom_postback_getGET /events/custom/postbackCustom Event Postback URL
SendX::EventApievents_revenue_postback_getGET /events/revenue/postbackRevenue Event Postback URL
SendX::EventsApitrack_custom_eventPOST /events/customTrack custom event
SendX::EventsApitrack_revenue_eventPOST /events/revenueTrack revenue event
SendX::ListApicreate_listPOST /listCreate list
SendX::ListApidelete_listDELETE /list/{identifier}Delete list
SendX::ListApiget_all_listsGET /listGet all lists
SendX::ListApiget_listGET /list/{identifier}Get list by ID
SendX::ListApiupdate_listPUT /list/{identifier}Update list
SendX::PostApicreate_postPOST /postCreate blog post
SendX::PostApidelete_postDELETE /post/{identifier}Delete post
SendX::PostApiget_all_postsGET /postGet all posts
SendX::PostApiget_postGET /post/{identifier}Get post by ID
SendX::PostApiupdate_postPUT /post/{identifier}Update post
SendX::PostCategoryApicreate_post_categoryPOST /post/categoryCreate post category
SendX::PostCategoryApidelete_post_categoryDELETE /post/category/{identifier}Delete post category
SendX::PostCategoryApiget_all_post_categoriesGET /post/categoryGet all post categories
SendX::PostCategoryApiget_post_categoryGET /post/category/{identifier}Get post category by ID
SendX::PostCategoryApiupdate_post_categoryPUT /post/category/{identifier}Update post category
SendX::PostTagApicreate_post_tagPOST /post/tagCreate post tag
SendX::PostTagApidelete_post_tagDELETE /post/tag/{identifier}Delete post tag
SendX::PostTagApiget_all_post_tagsGET /post/tagGet all post tags
SendX::PostTagApiget_post_tagGET /post/tag/{identifier}Get post tag by ID
SendX::PostTagApiupdate_post_tagPUT /post/tag/{identifier}Update post tag
SendX::ReportApiget_campaign_reportGET /report/campaign/{identifier}Get campaign report
SendX::SenderApicreate_senderPOST /senderCreate sender
SendX::SenderApiget_all_sendersGET /senderGet all senders
SendX::TagApicreate_tagPOST /tagCreate tag
SendX::TagApidelete_tagDELETE /tag/{identifier}Delete tag
SendX::TagApiget_all_tagsGET /tagGet all tags
SendX::TagApiget_tagGET /tag/{identifier}Get tag by ID
SendX::TagApiupdate_tagPUT /tag/{identifier}Update tag
SendX::TeamMemberApiget_all_team_membersGET /team/memberGet all team members
SendX::TeamMemberApiget_team_memberGET /team/member/{identifier}Get a team member by ID
SendX::TemplateApicreate_email_templatePOST /template/emailCreate email template
SendX::TemplateApidelete_email_templateDELETE /template/email/{identifier}Delete template
SendX::TemplateApiget_all_email_templatesGET /template/emailGet all templates
SendX::TemplateApiget_email_templateGET /template/email/{identifier}Get template by ID
SendX::TemplateApiupdate_email_templatePUT /template/email/{identifier}Update template
SendX::TrackingApiidentify_contactPOST /contact/identifyIdentify contact
SendX::TrackingApitrack_contactPOST /contact/trackTrack contact
SendX::WebhookApicreate_webhookPOST /webhookCreate webhook
SendX::WebhookApidelete_webhookDELETE /webhook/{identifier}Delete webhook
SendX::WebhookApiget_all_webhooksGET /webhookGet all webhooks
SendX::WebhookApiget_webhookGET /webhook/{identifier}Get webhook by ID
SendX::WebhookApiupdate_webhookPUT /webhook/{identifier}Update webhook
Documentation for Models
Documentation for Authorization
Authentication schemes defined for the API:
TeamApiKey
  • Type: API key
  • API key parameter name: X-Team-ApiKey
  • Location: HTTP header
About
No description, website, or topics provided.
Resources
Readme
MIT license
Activity
Custom properties
Stars
0 stars
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors
Languages