Update Survey Contact
Updates a specified contact within a survey campaign. One or more fields may be changed in a single call.
Endpoint
POST
v5/survey/{survey_id}/surveycampaign/{campaign_id}/surveycontact/{contact_id}
Requires authentication
Path Parameters
Identifies the survey, campaign, and specific contact to update.
survey_id
string
required
The ID of the survey.
campaign_id
string
required
The ID of the survey campaign.
contact_id
string
required
The ID of the contact to update.
Query Parameters
All parameters are optional except email_address. Include only the fields you want to update.
email_address
string
required
The contact's email address. Changes to standard contact fields for an existing email address are applied globally across all campaigns.
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.
team
string
The contact's team.
group
string
The contact's group.
role
string
The contact's role.
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.
mobilephone
string
The contact's mobile phone number. Used when updating contacts via an SMS campaign.
mailing_address
string
The contact's street address.
mailing_address2
string
The contact's secondary address line.
mailing_address_city
string
The contact's city.
mailing_address_state
string
The contact's state or region.
mailing_address_country
string
The contact's country.
mailing_address_postal
string
The contact's postal code.
title
string
The contact's job title.
url
string
A URL associated with the contact.
customfield1–10
string
Custom fields 1–10 for the email campaign contact list. Pass individually as
customfield1, customfield2, etc.custom[fieldname]
string
Custom fields from your account email lists. Example:
custom[customerid]=value. To find field names, go to Account > Email Lists > Manage Custom Fields.status
string
The contact's status. Accepted values:
Active, Inactive. Setting to Inactive will unsubscribe the contact from the campaign.Response
Returns the updated contact object. See List Survey Contacts for the full list of response fields.
result_ok
boolean
Whether the request succeeded.
data
object
The updated contact object.
Examples
Request (cURL)
curl -X POST "https://api.alchemer.com/v5/survey/123456/surveycampaign/100000/surveycontact/100039753?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&email_address=jon.doe@alchemer.com&title=Director"
Response
{
"result_ok": true,
"data": {
"id": 100039753,
"email_address": "jon.doe@alchemer.com",
"first_name": "Jon",
"last_name": "Doe",
"title": "Director",
"status": "Active",
"subscriber_status": "Unsent",
"date_last_sent": ""
}
}