resubscribeContact

Resets the unsubscribe flag on a Contact.

resubscribeContact

Resets the unsubscribe flag on a Contact.

Top ↑

Syntax

int resubscribeContact( string api_key, int list_id, int contact_id );

Parameters

api_key (string)

The key required to access the API. See Getting Started for more information.

list_id (int)

The ID of the List containing the Contact.

contact_id (int)

The ID of the Contact to resubscribe.

Return Value

Returns the Contact ID on success.

Examples

In the following example, Contact ID 234 is resubscribed to List 1234567.

$list_id = 1234567;     // can be obtained using searchLists()
$contact_id = 234;      // can be obtained using searchContacts()

$api = new Api($url, 'YOURAPIKEY');
$api->invokeMethod('resubscribeContact', $list_id, $contact_id);
{
    "id": 1,
    "method": "resubscribeContact",
    "params": [
        "YOURAPIKEY",
        1234567,
        234
    ]
}
{
    "id": 1,
    "result": 234,
    "error": null
}

Remarks

This method resets the unsubscribe flag on a Contact. It does not remove the Contact from the Unsubscriber List.

Error Codes

This method may return the following error codes in addition to the standard error codes:

Code Error Description
303 Unable to Load List list_id is not a valid List
304 Unable to Load Contact contact_id is not a valid Contact in the List
302 Undefined Error: Contact Resubscribe Failed An internal error occurred.

See Also