Using the Sure Send Partner API with Postman

The Sure Send Partner API Postman Collection provides a convenient way to test and explore our API endpoints directly in Postman. This collection is automatically generated from our OpenAPI specification and includes all available endpoints with example requests.

Download the Collection

You can download the latest Postman collection here:

Download Sure Send Partner API Collection

Note: This collection is automatically updated whenever changes are made to the API. Always download the latest version for the most up-to-date endpoints.

Importing into Postman

Method 1: Import from File (Recommended)

1. Download the collection using the link above
2. Open Postman (download from postman.com if you don't have it)
3. Click Import in the top-left corner
4. Drag and drop the downloaded JSON file, or click Choose Files to browse
5. Click Import to add the collection to your workspace

Method 2: Import from URL

1. Open Postman
2. Click Import in the top-left corner
3. Select the Link tab
4. Paste this URL:

   https://api.suresend.ai/downloads/sure-send-partner-api.postman_collection.json

5. Click Continue and then Import

Setting Up Your Environment

After importing the collection, you'll need to configure authentication:

1. Create a Postman Environment

1. Click the Environments tab in the left sidebar
2. Click + Create Environment
3. Name it "Sure Send API"
4. Add the following variables:

5. Click Save

2. Obtain Your API Key

If you don't have an API key yet:

1. Log into your Sure Send account
2. Navigate to Settings → Integrations → Partner API
3. Click Generate API Key
4. Copy the key and paste it into your Postman environment

Security Tip: Never share your API key or commit it to version control. Use Postman's "secret" variable type to keep it secure.

3. Configure the Collection

The collection should automatically use your environment variables. To verify:

1. Select the Sure Send Partner API collection
2. Go to the Variables tab
3. Ensure it's using {{baseUrl}} and {{apiKey}} from your environment
4. Select your Sure Send API environment from the dropdown in the top-right

Using the Collection

Authentication

All requests in the collection use Bearer token authentication. The API key is automatically included in the request headers:

Authorization: Bearer {{apiKey}}

Making Your First Request

Let's test the API by fetching the current user:

1. Expand the Sure Send Partner API collection
2. Navigate to User → Get Current User
3. Ensure your environment is selected
4. Click Send
5. You should see your user information in the response

Example Request Flow

Here's a typical workflow for working with people:

1. List People: GET /api/partner/people - View all people in your account
2. Get Person Details: GET /api/partner/people/:id - Get details for a specific person
3. Create Person: POST /api/partner/people - Add a new person
4. Update Person: PUT /api/partner/people/:id - Update person information
5. Delete Person: DELETE /api/partner/people/:id - Remove a person

Working with Variables

The collection uses Postman variables to make testing easier:

• Collection Variables: Shared across all requests (e.g., baseUrl)
• Environment Variables: Specific to your environment (e.g., apiKey)
• Request Variables: Specific to individual requests (e.g., personId)

After creating a resource, you can save its ID for use in subsequent requests:

// In the Tests tab of a POST request
const response = pm.response.json();
pm.environment.set("personId", response.id);

Then use it in the next request:

GET {{baseUrl}}/people/{{personId}}

Collection Structure

The collection is organized by resource types:

• People: Manage contacts and leads
• Companies: Manage company records
• Events: Track interactions and activities
• Tags: Organize records with labels
• Custom Fields: Work with custom data
• Webhooks: Manage webhook subscriptions
• User: Account and user information

Each folder contains the full CRUD operations (Create, Read, Update, Delete) where applicable.

Advanced Features

Pre-request Scripts

Some requests include pre-request scripts to:

• Generate timestamps
• Create unique identifiers
• Format data automatically

Tests

Many requests include automated tests that:

• Verify response status codes
• Validate response structure
• Check for required fields
• Store values for subsequent requests

You can run these tests by clicking Send and viewing results in the Test Results tab.

Bulk Testing with Collection Runner

To test multiple endpoints at once:

1. Click the Runner button at the bottom of the sidebar
2. Select the Sure Send Partner API collection
3. Choose your environment
4. Click Run Sure Send Partner API
5. View results for all requests in sequence

Troubleshooting

Common Issues

401 Unauthorized Error

• Verify your API key is correct in the environment variables
• Ensure the environment is selected in the top-right dropdown
• Check that your API key hasn't expired

404 Not Found

• Verify the baseUrl is correct: https://api.suresend.ai/api/partner
• Check that the resource ID exists (for GET/PUT/DELETE requests)
• Ensure you're using the correct endpoint path

422 Unprocessable Entity

• Review the request body - required fields may be missing
• Check the API documentation for field requirements
• Verify data types match the schema (e.g., strings, integers)

500 Internal Server Error

• Contact Sure Send support at [email protected]
• Include the request details and timestamp

Getting Help

If you encounter issues not covered here:

1. Check the API Documentation for endpoint details
2. Review the Authentication Guide for setup help
3. Contact support at [email protected] with:
   • The request you're trying to make
   • The error message received
   • Your account identifier (not your API key)

Keeping the Collection Updated

The Postman collection is automatically generated from our OpenAPI specification. When we add new endpoints or update existing ones:

1. Re-download the collection from the link above
2. Re-import into Postman (this will update existing requests)
3. Your environment variables and custom scripts will be preserved

Tip: Set a reminder to check for updates monthly, or subscribe to our API Changelog for notifications.

Best Practices

1. Use Environments: Keep separate environments for development, staging, and production
2. Save Responses: Use Postman's "Save Response" feature for reference
3. Document Custom Scripts: Add comments to any custom pre-request or test scripts
4. Share with Team: Export your configured collection and environment (without secrets) for team members
5. Version Control: Keep track of which collection version you're using

Additional Resources

• Partner API Documentation
• Getting Started Guide
• Authentication Guide
• Webhooks Guide
• Postman Learning Center

Support

For API-related questions or issues:

• Email: [email protected]
• Documentation: https://sure-send.readme.io
• Status Page: https://status.suresend.ai