Removes a company page photo.
Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
---|---|---|---|
CRTeamraiserAPI | None. | POST | Yes. |
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.
See topic Common Parameters.
Required. The unique ID of the company.
Type xsd:nonNegativeInteger.
Required. The TeamRaiser event ID.
Type xsd:nonNegativeInteger.
Required. If TRUE, confirms that the company photo should be deleted.
Type xsd:boolean.
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.
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.
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"}}}