removeContactFromGroup

Removes a contact from an address book group.

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
CRAddressBookAPI None. POST Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRAddressBookAPI?method=removeContactFromGroup &api_key=value &v=value [ &auth=value ] [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &contact_id=value &group_id=value [ &auth=value ] [ &sso_auth_token=value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

contact_id

Required. The system-generated unique contact ID for the contact.

Type xsd:nonNegativeInteger.

group_id

Required. The ID of the group you wish to remove the contact from.

Type xsd:nonNegativeInteger.

auth

Optional. You must provide either this parameter or the sso_auth_token parameter. If using this parameter, you must specify an auth token generated by an embedded [[S86]] session tag in a Convio web page.

sso_auth_token

Optional. You must provide either this parameter or the auth parameter. If using this parameter, you must specify a valid session authentication token returned by login, authenticateUser, or getSingleSignOnToken.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<removeContactFromGroupResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <group_id>123</group_id>
  <contact_id>45678</contact_id>
</removeContactFromGroupResponse>

        
JSON response
{"removeContactFromGroupResponse":{"contact_id":"45678","group_id":"123"}}

        

Leave a Comment

Nickname
Comment
Enter this word: