This API allows you to create a new contact in WooSender.

Endpoint

POST: https://api.woosender.com/api/services/contacts/import

Request Format

Send a JSON payload in the request body with the following parameters:

Parameter	Type	Description	Note
full_name	string	Concatenated first and last name	Ignored if `first_name` or `last_name` are provided.
first_name	string	Contact's given name.	Used to set contact's name; `full_name` ignored if provided.
last_name	string	Contact's family name.	Used to set contact's name; `full_name` ignored if provided.
email	string	Contact's email address.	If email doesn't exist, a new contact is created. If it exists, the associated contact is updated.
phone_number	string	Contact's phone number.	Timezone auto-detected based on the phone number if timezone is not specified or incorrect.
assignee_id	string	GUID of the user	Optional; leave blank for auto-assignment based on campaign round robin setting if any, or 'none' to unassign.
campaign_id	string	GUID of the campaign.	Optional; use 'none' to remove the contact from a campaign.
note	string	Note	Additional note regarding the contact.
tag_id	array	GUIDs of tags for categorizing the contact.	Used for categorizing the contact within WooSender. Multiple tags allowed.
company	string	Contact's Company
revenue	double	Revenue from the contact
pipeline_id	string	GUID of the pipeline
stage_id	string	GUID of the contact's stage within the pipeline	Must correspond to a stage in the specified `pipeline_id`.
timezone	string	Contact's time zone	Refer to List of Time Zones for valid values.
data	object	Optional; Contact custom fields	The `data` object allows you to include custom fields. Each key in the `data` object represents a custom field, identified by its `idCustomField`. There are five types of custom fields: 1. Singleline Text: Accepts string values. 2. Dropdown: Accepts string values corresponding to the selected dropdown option. 3. Currency: Accepts numeric values representing the currency amount. 4. Datetime: Accepts timestamps format. 5. Number: Accepts numeric values. 'Example `data` object: key1: value1, key2: value2, key3: value3 // Add more key-value pairs

Request Example:

curl -X POST  https://api.woosender.com/api/services/contacts/import \
-H "Content-Type: application/json" \
-H "X-Api-Key: dc519f76-5ac9-49b0-b796-6186d2843389" \
-H "X-Secret-Key: 276db9a6-c269-4fbe-a784-b72ad821057e" \
-d '{                
      "full_name": "Woosender Specialist",
      "first_name": "",
      "last_name": "",
      "email": "specialist@woosender.com",
      "phone_number": "+12345678901",
      "assignee_id": "0d1780ec-7d6a-4829-878b-8f1c9a3288f1",
      "campaign_id": "c9bac8df-9908-460a-995b-b0b520ebe09d",
      "note": "Imported from creating contact API",
      "tag_id": [
        "d1110542-3463-47a1-9bb4-0c356ca35166",
        "095b1bac-71e4-457c-806e-f52e9f4a209c",
        "ddda8cd7-582d-4ffc-b4f4-15a2903c75ed",
        "7e06b4a6-e569-4473-b9bb-a7a087c668eb"
                  ],
                  "company": "Joshua Guleserian",
                  "revenue": 10000,
                  "pipeline_id": "2cd0da03-066b-487e-bce0-6ff7ae8f05b5",
                  "stage_id": "d45fc10a-30d3-4029-ae6e-3c9c99e02476",
                  "timezone": "Pacific Standard Time",
                  "data": {
                    "1f93763f-2eb7-4fa5-b7ec-4364ee6e3d67": "drop-down-      value-1",
                    "9609dfd2-7713-442d-a1b8-dbc0786fd751": 100000,
                    "934ea5e9-4f55-4951-9591-b4658380d8cb": "2024-01-09T16:46:38.667Z"
                  }
                }'

Responses

Code	Description
200	Success

Rate Limiting

You are limited to 1000 requests per second.