removeCompanyPhoto

Removes a company page photo.

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

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=removeCompanyPhoto &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 ] &company_id=value &fr_id=value &photo_1_delete=value [ &auth=value ] [ &sso_auth_token=value ]

Usage Notes

This method requires authentication, and must include the company_id. Only the logged-in constituent who is identified as the Company Coordinator in the Company record has permission to execute this method.

The Company Coordinator is defined by the system administrator when the Company record is created.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

company_id

Required. The unique ID of the company.

Type xsd:nonNegativeInteger.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

photo_1_delete

Required. If TRUE, confirms that the company photo should be deleted.

Type xsd:boolean.

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"?>
<removeCompanyPhotoResponse 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">
  <photoItem>
    <id>123</id>
    <thumbnailUrl>http://www.example.com/thumbnailexample.jpg</thumbnailUrl>
  </photoItem>
</removeCompanyPhotoResponse>

        
JSON response
{"removeCompanyPhotoResponse":{"photoItem":{"id":"123","thumbnailUrl":"http://www.example.com/thumbnailexample.jpg"}}}

        

Leave a Comment

Nickname
Comment
Enter this word: