Response

{
 "success": true, 
 "responseCode": 1, 
 "message": "Successfully subscribed"
}

 

A brief explanation
listId: the id of the contact list, can be found in Contact > Manage Lists
email: must be in valid email address format
isSafeSubscribe: optional, default value is 1 if missing, possible value is 0 or 1
  0: if the email exist, the subscription status will be changed to subscribe even it is un-subscribed or bounced
  1: if the email exist, it will NOT subscribe the email if status is un-subscribed or bounced, that mean the status will be unchanged
firstName: max 255 characters, if not specified, this rule applies to other text field
country: Please refer to our country code table
gender: M, F or empty
customField: all custom fields start with 'c_', for example 'c_personal_website', and you can retrieve the definition (all the field names and captions) by another request here

For any fields that are not getting value in the subscription, you can simple exclude the field in the URI request.

All response

{"success": false, "responseCode": 0, 
 "message": "Error"}

{"success": true, "responseCode": 1, 
 "message": "Successfully subscribed"}

{"success": false, "responseCode": 2,
 "message": "Invalid email format"}

{"success": false, "responseCode": 3,
 "message": "Exceeded the maximum subscribers limit, please upgrade the subscriber plan."}

{"success": false, "responseCode": 4,
 "message": "Invalid custom field name."}

{"success": false, "responseCode": 5,
 "message": "Invalid business email address."}

{"success": false, "responseCode": 6,
 "message": "Invalid gender value."}

{"success": false, "responseCode": 7,
 "message": "Invalid list id."}

{"success": false, "responseCode": 8,
 "message": "Invalid country code."}

{"success": false, "responseCode": 9,
 "message": "The email is un-subscribed in the system."}

{"success": false, "responseCode": 10,
 "message": "The email is bounced in the system."}