DELETE /api/{service}/{ID}/picture

Deletes the avatar associated with the specified resource. This operation is currently available only to the users service. Once an avatar is in place for an app, API, or independent group, you can remove it only by replacing it with another custom avatar.

Authorization Roles/Permissions: Must be logged in. User (logged in) or Site Admin (for any user).

This topic includes the following sections:

HTTP Method

DELETE

Back to top

URL

https://{hostname}/api/users/{UserID}/picture

Back to top

Sample Request

The example below shows a request to delete the avatar for the specified user.

Request URL

https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/picture

Sample request headers

Accept: text/plain
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type Any format (*/*)
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
UserID Path string Required The unique ID of the resource for which the avatar is being deleted (UserID).

Back to top

Response

If successful, this operation returns HTTP status code 200, and the image is deleted. There is no response body.

Back to top

Sample Response

The sample response below shows that the operation completed successfully and the avatar was deleted. In this example, the avatar was one that had been uploaded to the platform.

Sample response headers

HTTP/1.1 200 OK
Date: Thu, 23 May 2013 19:32:32 GMT

Sample response body

None.

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

Not applicable.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401

Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.

You would also get this response if you were not an authorized user for the resource.

500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics