PUT ​/api​/v3​/account​/me​/artistprofile​/album​/:albumid

Update an artist album

Request

Example Request

{
  "auth_token": "abc1245920feab98ca",
  "album": {
    "title": "Yankee Hotel Foxtrot",
    "year": 2002,
    "credits": "Jeff Tweedy - Composer, Horn, String Arrangements",
    "producer": "Wilco",
    "record_label": "Nonesuch",
    "recorded_at": "The Loft (Chicago, IL, US)",
    "primary_genre": "Rock",
    "secondary_genre": "Alternative Rock",
    "tag_list": "alt-country, indie",
    "position": 1,
    "is_downloadable": true,
    "price": "9.99",
    "download_type": "",
    "itunes_url": "http://example.com/album",
    "amazon_url": "http://example.com/album",
    "external_url": "http://example.com/album",
    "remote_artwork_url": "http://example.com/albumcover.png"
  }
}

Example Parameters

  • auth_token: The user's auth_token obtained by calling the auth API.

    • Required: yes
    • Type: string
    • Example: abc1245920feab98ca
  • album: The photo object containing the attributes for the album to add.

    • Required: yes
    • title: The album title
      • Required: no
      • Type: string
      • Example: Yankee Hotel Foxtrot
    • year: The year the album was released
      • Required: no
      • Type: integer
      • Example: 2002
    • credits: Credits and/or notes about the production of the album
      • Required: no
      • Type:
        • null
        • string
      • Example: Jeff Tweedy - Composer, Horn, String Arrangements
    • producer: The album's producer
      • Required: no
      • Type:
        • null
        • string
      • Example: Wilco
    • record_label: The album's record label
      • Required: no
      • Type:
        • null
        • string
      • Example: Nonesuch
    • recorded_at: The location(s) where the album was recorded
      • Required: no
      • Type:
        • null
        • string
      • Example: The Loft (Chicago, IL, US)
    • primary_genre: The album's primary genre
      • Required: no
      • Type:
        • null
        • string
      • Example: Rock
    • secondary_genre: The album's secondary genre
      • Required: no
      • Type:
        • null
        • string
      • Example: Alternative Rock
    • tag_list: Additional album genre tags
      • Required: no
      • Type: string
      • Example: alt-country, indie
    • position: The album sort/display position
      • Required: no
      • Type: integer
      • Example: 1
    • is_downloadable: Whether or not the album can be downloaded
      • Required: no
      • Type: boolean
    • price: The album price
      • Required: no
      • Type: string
      • Example: 9.99
    • download_type: The album download type. Valid values are "range" (pay-what-you-want above the specified minimum price), "free", "fixed" (only the specified price), or "external" (the price specified on iTunes, Amazon, or the external URL).
      • Required: no
      • Type:
        • null
        • string
    • itunes_url: The URL for purchasing the album on iTunes
      • Required: no
      • Type:
        • null
        • string
      • Example: http://example.com/album
    • amazon_url: The URL for purchasing the album on Amazon
      • Required: no
      • Type:
        • null
        • string
      • Example: http://example.com/album
    • external_url: The URL for purchasing the album on an external site
      • Required: no
      • Type:
        • null
        • string
      • Example: http://example.com/album
    • remoteartworkurl: URL to an image
      • Required: no
      • Type:
        • null
        • string
      • Format: uri
      • Example: http://example.com/albumcover.png

Response

Example Response

{
  "album": {
    "id": 1,
    "title": "Yankee Hotel Foxtrot",
    "year": 2002,
    "artwork": [
      {
        "thumb": {
          "url": "http://example.com/album_thumb.png"
        },
        "mini_profile": {
          "url": "http://example.com/album_mini_profile.png"
        }
      }
    ],
    "credits": "Jeff Tweedy - Composer, Horn, String Arrangements",
    "producer": "Wilco",
    "record_label": "Nonesuch",
    "recorded_at": "The Loft (Chicago, IL, US)",
    "primary_genre": "Rock",
    "secondary_genre": "Alternative Rock",
    "tag_list": "garage, psych",
    "position": 1,
    "is_downloadable": true,
    "price": "9.99",
    "download_type": "fixed",
    "itunes_url": "http://example.com/album",
    "amazon_url": "http://example.com/album",
    "external_url": "http://example.com/album"
  }
}

Response Parameters

  • album:

    • Required: yes
    • id: The unique ID of the album
      • Required: yes
      • Type: integer
      • Example: 1
    • title: The album title
      • Required: no
      • Type: string
      • Example: Yankee Hotel Foxtrot
    • year: The year the album was released
      • Required: no
      • Type: integer
      • Example: 2002
    • artwork: The album cover image details

      • Required: no
      • Type: array
      • Items

        • Required: no
        • thumb: The thumbnail size album cover image URL

          • Required: no
          • __url__:

        • mini_profile: The mini profile size album cover image URL

          • Required: no
          • __url__:

    • credits: Credits and/or notes about the production of the album

      • Required: no
      • Type:
        • null
        • string
      • Example: Jeff Tweedy - Composer, Horn, String Arrangements
    • producer: The album's producer

      • Required: no
      • Type:
        • null
        • string
      • Example: Wilco
    • record_label: The album's record label

      • Required: no
      • Type:
        • null
        • string
      • Example: Nonesuch
    • recorded_at: The location(s) where the album was recorded

      • Required: no
      • Type:
        • null
        • string
      • Example: The Loft (Chicago, IL, US)
    • primary_genre: The album's primary genre

      • Required: no
      • Type:
        • null
        • string
      • Example: Rock
    • secondary_genre: The album's secondary genre

      • Required: no
      • Type:
        • null
        • string
      • Example: Alternative Rock
    • tag_list: Additional album genre tags

      • Required: no
      • Type:
        • null
        • array
      • Example: garage, psych
    • position: The album sort/display position

      • Required: no
      • Type: integer
      • Example: 1
    • is_downloadable: Whether or not the album can be downloaded

      • Required: no
      • Type: boolean
    • price: The album price

      • Required: no
      • Type: string
      • Example: 9.99
    • download_type: The album download type. Valid values are "range" (pay-what-you-want above the specified minimum price), "free", "fixed" (only the specified price), or "external" (the price specified on iTunes, Amazon, or the external URL).

      • Required: no
      • Type:
        • null
        • string
      • Example: fixed
    • itunes_url: The URL for purchasing the album on iTunes

      • Required: no
      • Type:
        • null
        • string
      • Example: http://example.com/album
    • amazon_url: The URL for purchasing the album on Amazon

      • Required: no
      • Type:
        • null
        • string
      • Example: http://example.com/album
    • external_url: The URL for purchasing the album on an external site

      • Required: no
      • Type:
        • null
        • string
      • Example: http://example.com/album

Response Codes

Successful Response Codes

  • 200: The artist album was updated.

Failure Response Codes

  • 422: Indicates a bad request including validation errors.

  • 404: Indicates the account or album was not found.

  • 401: Unauthorized request. Indicates a missing or invalid auth_token.