Skip to main content

​
Welcome to SendX

This quick start guide will help you:
  • Set up your SendX account
  • Identify your first contact using the REST API
  • Get ready to send your first email
Let’s dive in!

​
1. Set Up Your SendX Account

Start by creating a SendX account if you haven’t already: Create Account → After registering, log in and navigate to: Settings → API & Webhooks → Copy your Team API Key
This key is required for all API interactions. Keep it safe and never expose it in public code repositories.

​
2. Identify a Contact

Use the identify method of the SendX REST API to start adding your contacts to the SendX App, this would allow you to send email to that contact later: 
curl --request POST \
  --url https://api.sendx.io/api/v1/rest/contact/identify \
  --header 'Content-Type: application/json' \
  --header 'X-Team-ApiKey: <YOUR_TEAM_API_KEY>' \
  --data '{
  "firstName": "John",
  "lastName": "Doe",
  "email": "user@example.com",
  "newEmail": "user@example.com",
  "company": "Acme Inc.",
  "tags": [
    "new",
    "cool"
  ],
  "customFields": {
    "favorite_color": "blue",
    "favorite_food": "pizza"
  }
}'
This would create a new contact with the following details: 
First Name: John
Last Name: Doe
Email: user@example.com
New Email: user@example.com
Company: Acme Inc.
Tags: new, cool 
Custom Fields: favorite_color: blue, favorite_food: pizza

Identify REST API

For more details on the identify method, check out the API reference.
 Once you have identified your contact, you can start sending emails to them.

​
Next Steps

Once your contact is identified, you can start sending emails to them using the SendX API.

​
Want to go further?

  • Send transactional emails
  • Run campaigns and newsletters
  • Segment contacts with tags and custom fields
Explore everything in our API Reference.
⌘I