updateInteraction

This method can be used to update an interaction record with information supplied by the caller. It must be called by a logged-in user within an authenticated session. This method requires an interaction ID. The interaction being updated can only be of the interaction type "Other" or a custom interaction type.

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
CRConsAPI SRConsAPI POST Server.

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=updateInteraction &api_key=value &v=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 ] &interaction_id=value [ &interaction_body=value ] [ &interaction_cat_id=value ] [ &interaction_count=value ] [ &interaction_subject=value ] [ &interaction_type_id=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRConsAPI?method=updateInteraction & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & interaction_id =value [ & interaction_body =value ] [ & interaction_cat_id =value ] [ & interaction_count =value ] [ & interaction_subject =value ] [ & interaction_type_id =value ]

Usage Notes

If called as a Client API, this method requires authentication. If the requester is a constituent using the Client API an authentication token representing the logged-in user must be passed.

The updateInteraction method updates an existing interaction record for the constituent using the values (if any) supplied in the interaction_cat_id, interaction_subject, interaction_body, interaction_count and interaction_id parameters. Only interactions of type 0='Other' or a custom interaction type can be updated.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

interaction_id

Required. The id of the interaction to update.

Type xsd:nonNegativeInteger.

interaction_body

Optional. Text describing or associated with the interaction.

Type xsd:string.

interaction_cat_id

Optional. The Security Category associated with this interaction. The default is 0, which corresponds to the "General" category.

Type xsd:nonNegativeInteger.

Default is 0.

interaction_count

Optional. The number of times the constituent performed this interaction.

Type xsd:nonNegativeInteger.

Default is 1.

interaction_subject

Optional. Short, descriptive subject of the user interaction. Can be up to 80 characters in length.

Type xsd:string.

interaction_type_id

Optional. The Interaction Type associated with this interaction.

Type xsd:nonNegativeInteger.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

interaction_id

Required. The id of the interaction to update.

Type xsd:nonNegativeInteger.

interaction_body

Optional. Text describing or associated with the interaction.

Type xsd:string.

interaction_cat_id

Optional. The Security Category associated with this interaction. The default is 0, which corresponds to the "General" category.

Type xsd:nonNegativeInteger.

Default is 0.

interaction_count

Optional. The number of times the constituent performed this interaction.

Type xsd:nonNegativeInteger.

Default is 1.

interaction_subject

Optional. Short, descriptive subject of the user interaction. Can be up to 80 characters in length.

Type xsd:string.

interaction_type_id

Optional. The Interaction Type associated with this interaction.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<updateInteractionResponse 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">
  <cons_id>1001001</cons_id>
  <message>Interaction updated successfully.</message>
  <interactionId>1001</interactionId>
</updateInteractionResponse>

        
JSON response
{"updateInteractionResponse":{"message":"Interaction updated successfully.","interactionId":"1001","cons_id":"1001001"}}

        

Leave a Comment

Nickname
Comment
Enter this word: