CREATE

Create Contact List Contact

Creates a new contact inside a specified contact list.

Endpoint

PUT v5/contactlist/{list_id}/contactlistcontact

Requires authentication

Path Parameters

The contact list to add the contact to.

list_id
string
required
The ID of the contact list.

Query Parameters

email_address
string
required
The contact's email address.
status
string
The contact's status. Values: Active, Inactive.
first_name
string
The contact's first name.
last_name
string
The contact's last name.
organization
string
The contact's organization.
division
string
The contact's division.
department
string
The contact's department.
group
string
The contact's group.
role
string
The contact's role.
is_manager
boolean
Whether the contact is a manager.
team
string
The contact's team.
home_phone
string
The contact's home phone number.
fax_phone
string
The contact's fax number.
business_phone
string
The contact's business phone number.
mailing_address
string
The contact's mailing address (line 1).
mailing_address2
string
The contact's mailing address (line 2).
mailing_address_city
string
The contact's city.
mailing_address_state
string
The contact's state or province.
mailing_address_postal
string
The contact's postal or ZIP code.
mailing_address_country
string
The contact's country code. Example: US.
title
string
The contact's job title.
url
string
The contact's website URL.
custom
object
Custom fields defined in the contact list. Each key is the numeric custom field ID.

Custom field IDs are account-specific. To find custom field IDs for your contact list, use the Contact Custom Field endpoint.

Response

Returns the result of the creation request and the newly created contact object.

result_ok
boolean
Whether the request succeeded.
data
object
The newly created contact object. See List Contact List Contacts for the full list of response fields.

Examples

Request (cURL)
curl -X PUT "https://api.alchemer.com/v5/contactlist/YOUR_LIST_ID/contactlistcontact?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&email_address=jon.doe%40example.com&first_name=Jon&last_name=Doe"
Response
{
  "result_ok": true,
  "data": {
    "id": 100012345,
    "email_address": "jon.doe@example.com",
    "status": "Active",
    "first_name": "Jon",
    "last_name": "Doe",
    "organization": "",
    "division": "",
    "department": "",
    "group": "",
    "role": "",
    "is_manager": false,
    "team": "",
    "home_phone": "",
    "fax_phone": "",
    "business_phone": "",
    "mailing_address": "",
    "mailing_address2": "",
    "mailing_address_city": "",
    "mailing_address_state": "",
    "mailing_address_postal": "",
    "mailing_address_country": "",
    "title": "",
    "url": ""
  }
}