Update Item Image

PUT /item_images/{itemImageId}

Api key auth

Update an item image

Path parameters

itemImageId string(guid) Required

Unique ID of the item image

application/json

Body

item_image object
Hide item_image attribute Show item_image attribute object
- sort_order integer(int32)
  
  Set Image as the first image/primary image

Responses

200 application/json

Item Image updated
Hide response attributes Show response attributes object
- id string(guid)
  
  System generated unique identifier. Don't include this in POST request body.
- item_id string(guid)
- sort_order integer(int32)
  
  Sort order of the image
- url string(uri)
- created_at string(date-time)
- updated_at string(date-time)

PUT /item_images/{itemImageId}

curl \
 --request PUT 'https://app.getfoundation.com/api/external/v1/item_images/{itemImageId}' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"item_image":{"sort_order":1}}'

Request examples

{
  "item_image": {
    "sort_order": 1
  }
}

Response examples (200)

{
  "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
  "item_id": "string",
  "sort_order": 1,
  "url": "https://example.com",
  "created_at": "2025-05-04T09:42:00Z",
  "updated_at": "2025-05-04T09:42:00Z"
}