Subscriber Update (Subscriber.Update)

Description

Updates subscription information of an email address

Input Parameters

Command=Subscriber.Update [required]

Required command to perform API request

ResponseFormat [optional] [default=XML]

Defines the response data format. It can be equal to XML or JSON .

SessionID [required]

Your session ID. In order to run this API call, you need to be logged in and have session ID.

SubscriberID [required]

ID number of the target subscriber

EmailAddress [optional]

New email address of the subscriber

Fields [optional]

Custom field information for the email address. This information will be provided as array such as Fields[CustomField4], Fields[CustomField5], etc.

Output Parameters

Success [true or false]

If an error has occurred, this parameter will be equal to false. Otherwise it will be set to true.

ErrorCode [integer]

If an error has occurred, this parameter will contain error codes. Otherwise it will be set to 0.

SessionID [string]

If login was successful, this parameter will contain the session ID that you will need on your following API calls.

Error Codes

#1

List ID is missing

#2

List not found

#3

Email address already exists in the target subscriber list

#4

Subscriber ID does not exist in the target list

#5

Custom field validation failed

#6

Invalid email address format

#7

Subscriber ID is missing

#9998

Unauthorized access. User login required to execute this API call.

#9999

Invalid API call. Please check the API command and try again.