Add/edit contacts with the API

```mediawiki Navigation: Main_Page > API > add/edit contacts with the API

How do I add/edit contacts with the API?

Introduction

The ability to add and edit contacts effectively is vital for any business looking to manage its customer relationships efficiently. ActiveCampaign provides a powerful feature through its API that allows users to manage contacts with ease. This capability enables businesses to interact with their contacts programmatically, ensuring that the database reflects the most current information. By leveraging the contact_sync API call, you can add or edit a contact based on their email address in a single request, making the management of contacts more efficient.

This feature is available for all ActiveCampaign plans, including Starter, Plus, Pro, and Enterprise. Understanding how to utilize this API call can dramatically streamline your workflow, improving your overall efficiency when handling customer data.

How to access this feature

To access the add/edit contacts functionality using the API, you will need to send a POST request to the ActiveCampaign's API endpoint that handles contact synchronization. Specifically, this is performed using the contact_sync API call. Ensure you have your API key and base URL for your ActiveCampaign account, as these are required for authentication when making API requests.

Step-by-step instructions

Follow these steps to add or edit contacts using the API:

1. **Gather Required Information**: Before making the API call, ensure you have the following information:

  - The contact's email address
  - Other optional fields such as first name, last name, phone number, etc.
 

2. **Construct Your API Request**:

  - The API request should be formatted as a JSON or XML object depending on your preferred output format. Here are the basic parameters required:
    - `email`: The email address of the contact (this is mandatory)
    - `first_name`: (optional) The contact's first name
    - `last_name`: (optional) The contact's last name
    - Additional fields can be included as required.

3. **Make a POST Request**: Use your preferred method (e.g., cURL, Postman) to send the POST request to the ActiveCampaign API endpoint. For example, the endpoint for the contact_sync would look like:

  ```
  https://<your_account>.api.activecampaign.com/api/3/contact_sync
  ```

4. **Review the API Response**: After submitting the request, check the response to confirm whether the contact was added or updated successfully. The API will typically return a status code along with relevant data about the request.

Configuration options and settings

When working with the contact_sync API call, there are several important configuration options to be aware of: - **Email**: The unique identifier for each contact. - **First Name**: The contact’s first name, which can be included to personalize communications. - **Last Name**: Last name of the contact, also beneficial for personalization. - Additional fields you may include depend on how you want to segment or define your contacts within the platform.

Best practices and tips

- **Validate Email Addresses**: Always ensure that the email addresses you are adding or editing are valid to avoid unnecessary errors. - **Use Distinct Identifiers**: When dealing with contacts, use distinct identifiers such as email to prevent duplication. - **Check API Limits**: Be mindful of your API rate limits to avoid throttling. Batch requests can help maintain efficiency. - **Test Changes**: Utilize a sandbox environment for testing before deploying changes in a live setting.

Common use cases with examples

1. **Batch Contact Import**: When setting up a marketing campaign, you can use the contact_sync API to import a list of new contacts that have signed up via your website.

2. **Updating Existing Contacts**: If a customer changes their email address or contact information, use this API call to update their existing record without recreating it.

3. **Data Maintenance**: Periodically use the contact_sync API to keep contact information current by running routines that check and update contact details.

Troubleshooting

If you encounter issues while using the contact_sync API call, here are some common troubleshooting steps: - **Check API Key and URL**: Make sure that your API key and base URL are correctly set up in your request. - **Error Codes**: Review any error codes returned in the API response to understand what went wrong. - **Contact Existence**: Ensure that the email address you are trying to add or edit matches the format expected by ActiveCampaign.

Related features

For more options related to managing contacts, you may want to explore the following features: - Contact Lists - User Groups - Automation

FAQ

Q1: What is the primary purpose of the contact_sync API call? A1: The contact_sync API call allows you to add or edit a contact based on their email address without needing to check if a contact exists first.

Q2: Can I add multiple contacts at once with this API? A2: The contact_sync API call is intended for one contact per request. For batch operations, consider using other API methods or looping through an array of contacts.

Q3: What output formats does the contact_sync API support? A3: The supported output formats for contact_sync are xml, json, and serialize.

Q4: Do I need any specific permissions to access the API? A4: Ensure that your ActiveCampaign account has API access permissions enabled.

Q5: Is there a limit to the number of contacts I can sync in a day? A5: Yes, be aware of your API limits as outlined in your ActiveCampaign account documentation to avoid throttling.

Q6: What happens if I try to sync a contact that does not exist? A6: If the contact does not exist, the contact_sync will create a new contact under the provided email.

Q7: Can I remove contacts using the contact_sync API? A7: The contact_sync API is used exclusively for adding and editing contacts. To delete contacts, you would use a different API call. ```