Accessing API Documentation to Create a New Contact

02:56 mins
S

SendX

Updated on Jul 23, 2025

How to Manage API Requests and Create a Contact in the System

Step 1: Access API Reference

  • Click on the API Reference tab in the navigation bar.

  • Select Get All Lists from the sidebar menu.

  • In the Get All Lists section, click the Try It button.

Step 2: Retrieve API Key

  • Click on the Profile icon in the top right corner.

  • Select Settings from the drop-down menu.

  • In the navigation bar, click on API and Webhooks.

  • Copy the API key.

Step 3: Execute API Request

  • In the form, enter the API key in the Xteam API key field.

  • Click the Send button to execute the request.

  • In the response, locate the list to which you wish to add contacts.

  • Note the highlighted list name and the list ID in the API response section.

  • Copy the highlighted ID field with a specific identifier.

Step 4: Create a Contact

  • In the navigation bar, click on Create a Contact under the Contact section.

  • On the Create a Contact page, click the Try It button.

  • In the form, enter the email address in the highlighted field.

  • Enter the necessary details in the form.

  • Click on Plus Add an Item under the List section in the form.

  • Enter a value list ID.

  • Click the Send button in the form to submit the contact data.

Step 5: Verify Contact Creation

  • View the success message indicating the contact was created successfully.

  • Click on the Audience drop-down in the navigation bar.

  • Select Contacts.

  • In the Contacts, you will find the email has been successfully added.

  • The contact has been successfully added to SendX.