Knowledge Base: images.update

images.update

HTTP Method: POST
Required Parameters: api_key, user_token, token
Optional Parameters: name, description, url, rating, date_taken, privacy_level_id, rating, tags

Updates the metadata for an existing image.

Required Parameters

api_key:        API token for your client.
user_token:     The user token for the owner of the image.
token:          The token of the image to be edited.

Optional Parameters

name:               The name of the image [string] (100 characters max)
description:        Description of the image [string]
url:                A url for the image, should be fully formed inc. protocol [string]
date_taken:         Unix timestamp of the date the image was taken. [int]
privacy_level_id:   An id to set the privacy level of the image to. [int]
rating:             An integer between 0 and 5 [int]
tags:               A comma separated list of tags. [string]

Usage

Simply send a HTTP POST request containing the above parameters in the body.

https://api.emberapp.com/images/delete

Response

On success: HTTP 200 response.

<?xml version="1.0"?>
<response>
    <status code="0">OK</status>
    <api>api.images.update</api>
</response>

On failure: HTTP 400 response plus an array of errors.

<?xml version="1.0"?>
<response>
    <status code="1">FAIL</status>
    <api>api.images.update</api>
    <errors>
        <error id="123717114249007c73f1873">
            <rating>Rating must be numeric, between 0 and 5.</rating>
        </error>
    </errors>
</response>