This endpoint is currently in BETA.
Experiment with this API

Boards - Update Board

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to update a Board by a specific id.

Quickstart

You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.

Use the following endpoint to update details for a specific board:

PUT https://api.gettyimages.com/v3/boards/<board id>

Add API key and the Resource Owner Grant token to the request header:

Api-Key: <your api key>
Authorization: Bearer <your secure access token>

The request body should look like:

{
  "name": "Update Name",
  "description": "Update Description"
}

NOTE: The input to this endpoint is not sanitized in any way, so it is the responsibility of the client to ensure that it is properly formatted and guards against malicious data (for example cross-site scripting attacks or HTML injection) when accessing the data.

Your request would look like this using curl:

curl -X PUT -H 'Authorization: Bearer <secure access token>' -H 'Api-Key: <your api key>' -H 'Content-Type: application/json' 'https://api.gettyimages.com/v3/boards/<your board ID>' -d $'{\n  "name": "Update Name",\n  "description": "Update Description"\n}'

If successful your response will contain no content in the body and return code 204 Updated.

Request Headers

Api-Key string Provide your API key. Required.
Authorization string Provide access token in the format of 'Bearer {token}'. Required.
Accept-Language string Provide a header to specify the language of result values.

URI Path Parameters

board_id string Specify the board to update. Required.

Request Body Fields

board_info

name string
description string

Response Status Codes

204 Updated
400 InvalidParameterValue
400 BoardNameRequired
401 Unauthorized
403 SecureTokenRequired
403 InsufficientAccess
404 BoardNotFound