Feature video

cURL

curl -X PUT "https://api.alura.io/v1/workspace/listings/1834720561/videos/featured" \
  -H "Authorization: Bearer $ALURA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c" \
  -d '{"video_id":"5101"}'

const res = await fetch('https://api.alura.io/v1/workspace/listings/1834720561/videos/featured', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.ALURA_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': '5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c',
  },
  body: JSON.stringify({
    "video_id": "5101"
  }),
});
console.log(await res.json());

import json
import os
import urllib.request

request = urllib.request.Request(
    "https://api.alura.io/v1/workspace/listings/1834720561/videos/featured",
    method="PUT",
    data=json.dumps({
      "video_id": "5101"
    }).encode(),
    headers={
        "Authorization": f"Bearer {os.environ['ALURA_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": "5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c",
    },
)
with urllib.request.urlopen(request) as response:
    print(json.load(response))

{
  "object": "workspace.listing_videos",
  "listing_id": "<string>",
  "shop_id": "<string>",
  "added": [
    "<string>"
  ],
  "removed": [
    "<string>"
  ],
  "featured": {
    "video_id": "<string>",
    "from": "<string>"
  },
  "as_of": "<string>",
  "change": {
    "id": "<string>",
    "status": "succeeded",
    "applied_fields": [
      "<string>"
    ],
    "failed_fields": [
      {
        "field": "<string>",
        "code": "<string>"
      }
    ]
  },
  "notices": [
    {
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "object": "workspace.change",
  "id": "chn_01JMOCK0000000000000000MEDIA",
  "shop_id": "22841907",
  "target": {
    "type": "listing",
    "id": "1834720561"
  },
  "source": "api",
  "actor": {
    "type": "key",
    "id": "key_01JMOCK0000000000000000000"
  },
  "write_id": "wrt_01JMOCK0000000000000000MEDIA",
  "outcome": "applying",
  "fields": null,
  "applied_fields": null,
  "failed_fields": null,
  "before_source": null,
  "before_as_of": null,
  "event": null,
  "revertable": false,
  "not_revertable_reason": "outcome_unknown",
  "reverts": null,
  "created_at": "2026-10-17T12:00:00.000Z",
  "as_of": "2026-10-17T12:00:00.000Z"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "https://docs.alura.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Unauthorized",
  "suggestion": "Send a valid API key as `Authorization: Bearer alura_sk_...`.",
  "retryable": false,
  "request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "https://docs.alura.io/errors/method_not_allowed",
  "title": "Method not allowed",
  "status": 405,
  "code": "method_not_allowed",
  "detail": "Method not allowed",
  "suggestion": "Use one of the methods in the Allow header.",
  "retryable": false,
  "request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

cURL

curl -X PUT "https://api.alura.io/v1/workspace/listings/1834720561/videos/featured" \
  -H "Authorization: Bearer $ALURA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c" \
  -d '{"video_id":"5101"}'

const res = await fetch('https://api.alura.io/v1/workspace/listings/1834720561/videos/featured', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.ALURA_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': '5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c',
  },
  body: JSON.stringify({
    "video_id": "5101"
  }),
});
console.log(await res.json());

import json
import os
import urllib.request

request = urllib.request.Request(
    "https://api.alura.io/v1/workspace/listings/1834720561/videos/featured",
    method="PUT",
    data=json.dumps({
      "video_id": "5101"
    }).encode(),
    headers={
        "Authorization": f"Bearer {os.environ['ALURA_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": "5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c",
    },
)
with urllib.request.urlopen(request) as response:
    print(json.load(response))

{
  "object": "workspace.listing_videos",
  "listing_id": "<string>",
  "shop_id": "<string>",
  "added": [
    "<string>"
  ],
  "removed": [
    "<string>"
  ],
  "featured": {
    "video_id": "<string>",
    "from": "<string>"
  },
  "as_of": "<string>",
  "change": {
    "id": "<string>",
    "status": "succeeded",
    "applied_fields": [
      "<string>"
    ],
    "failed_fields": [
      {
        "field": "<string>",
        "code": "<string>"
      }
    ]
  },
  "notices": [
    {
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "object": "workspace.change",
  "id": "chn_01JMOCK0000000000000000MEDIA",
  "shop_id": "22841907",
  "target": {
    "type": "listing",
    "id": "1834720561"
  },
  "source": "api",
  "actor": {
    "type": "key",
    "id": "key_01JMOCK0000000000000000000"
  },
  "write_id": "wrt_01JMOCK0000000000000000MEDIA",
  "outcome": "applying",
  "fields": null,
  "applied_fields": null,
  "failed_fields": null,
  "before_source": null,
  "before_as_of": null,
  "event": null,
  "revertable": false,
  "not_revertable_reason": "outcome_unknown",
  "reverts": null,
  "created_at": "2026-10-17T12:00:00.000Z",
  "as_of": "2026-10-17T12:00:00.000Z"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "https://docs.alura.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Unauthorized",
  "suggestion": "Send a valid API key as `Authorization: Bearer alura_sk_...`.",
  "retryable": false,
  "request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "https://docs.alura.io/errors/method_not_allowed",
  "title": "Method not allowed",
  "status": 405,
  "code": "method_not_allowed",
  "detail": "Method not allowed",
  "suggestion": "Use one of the methods in the Allow header.",
  "retryable": false,
  "request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "suggestion": "<string>",
  "retryable": true,
  "request_id": "<string>",
  "upgrade_url": "<string>",
  "credits_needed": 123,
  "credits_remaining": 123,
  "resets_at": "2023-11-07T05:31:56Z",
  "change_id": "<string>",
  "budget": "<string>",
  "reason": "<string>",
  "changed": [
    "<string>"
  ],
  "missing": [
    "<string>"
  ],
  "reconnect_url": "<string>",
  "missing_scopes": [
    "<string>"
  ]
}

Cost: 1 API credit per write.

curl -X PUT "https://api.alura.io/v1/workspace/listings/1834720561/videos/featured" \
  -H "Authorization: Bearer $ALURA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"video_id": "5101"}'

Changes the live listing on Etsy. Needs the listings:write scope and the Listing optimization workspace permission. Send dry_run=true to see what would be sent without sending it.

Videos can’t be reverted (not_revertable_reason: "images"). For a few seconds during the change, the listing shows only the chosen video.

How it works

Etsy shows videos in the order they were added and has no reorder. So Alura takes the video ahead of the chosen one off the listing and adds it back, which puts it last. Both videos keep their IDs, and nothing is uploaded. The answer is 202 with the write’s change, outcome: "applying". Poll Get change at Location. A retry under the same Idempotency-Key, once the write has finished, answers what landed, with featured.video_id. See Idempotency.

Which videos can be featured

A video of another listing answers 404. An inactive one answers 400. A video whose state Alura’s copy doesn’t know is sent, and Etsy’s live state decides: one not active there answers 422 naming videos.target_not_live.

A video added elsewhere since the last sync

The change is planned on the active videos in Alura’s copy. If Etsy has an active video Alura’s copy doesn’t, nothing is written (videos.video_state_changed).

Busy listings

Another write to the listing still running answers 409 listing_busy: retry after Retry-After.

Credits and limits says when a write is charged.

Authorizations

Authorization

string

header

required

An API key: Authorization: Bearer alura_sk_....

Headers

Idempotency-Key

string

Makes a retry safe: the same key with the same request within 24 hours answers from the first write (with Idempotent-Replayed: true) and never writes to Etsy twice; a write that failed with nothing written (Retry-After set) is tried again under it. The same key with a different request is a 409 conflict; while the first request still runs, 409 idempotency_processing (or the same 202). Required for relative changes such as adjust_price, and to add a listing file, image or video, or to change the alt text of an image (each uploads to Etsy, so a blind retry would upload again); a dry_run=true needs none.

Required string length: 1 - 255

Path Parameters

string

required

The Etsy listing ID. A listing outside the workspace is 404.

Pattern: ^[0-9]{1,20}$

Example:

"1834720561"

Query Parameters

dry_run

boolean

true: plan the write and send nothing: what it would change, the Etsy calls it would make, and nothing reserved, charged or recorded. Free; counts toward the per-minute write limit.

Body

application/json

video_id

string

required

The video to show first (Etsy's featured video). A video of another listing is 404.

Pattern: ^[1-9][0-9]{0,18}$

Response

OK: the write landed on Etsy (or, with dry_run=true, what it would do).

Option 1
Option 2

object

string

required

Allowed value: "workspace.listing_videos"

listing_id

string

required

Etsy ID, as a string.

shop_id

string

required

Etsy ID, as a string.

added

string[]

required

Etsy's IDs of the videos added.

Etsy ID, as a string.

removed

string[]

required

The videos removed.

Etsy ID, as a string.

featured

object | null

required

After choosing the featured video: Etsy shows videos in the order they were added and has no reorder, so Alura moved the video ahead of the chosen one behind it (off the listing and back on). Null otherwise.

Show child attributes

as_of

string

required

When Etsy answered the write.

change

object

required

The write: its change ID and what landed.

Show child attributes

notices

object[]

required

What the answer leaves out and why; empty when nothing is.

Show child attributes

Overview

Research

Your shop

Etsy

Webhooks & events

Account

How it works

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response

​How it works

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response

How it works