Vision 6

deactivateContact

Deactivates a Contact in a List.

deactivateContact

Deactivates a Contact in a List.

Top ↑

Syntax

int deactivateContact( 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 deactivate.

Return Value

Returns the ID of the deactivated Contact on success.

Examples

The following code deactivates contact 234 in List 1234567.

PHP

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

$api = new Api($url, 'YOURAPIKEY');
$api->invokeMethod('deactivateContact', $list_id, $contact_id);

JSON Request

{
    "id": 1,
    "method": "deactivateContact",
    "params": [
        "YOURAPIKEY",
        1234567,
        234
    ]
}

JSON Response

{
    "id": 1,
    "result": 234,
    "error": null
}

Remarks

When a Contact is deactivated they do not receive any Messages sent to the 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 Deactivation Failed An internal error occurred.

See Also