Tags

Show all tags for the given media

get
Authorizations
Path parameters
media_idinteger · int64Required

The ID of the media.

Responses
201
The tag object(s) for the given media.
application/json
get
GET /api/public/v1/media/{media_id}/tags HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ]
}

Create a new tag for the given media

post
Authorizations
Path parameters
media_idinteger · int64Required

The ID of the media.

Query parameters
namestringRequired

The name of the tag.

Responses
201
The tag object that was created.
application/json
post
POST /api/public/v1/media/{media_id}/tags HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "tag": {
    "id": 1,
    "name": "text"
  }
}

Delete a tag by its id

delete
Authorizations
Path parameters
media_idinteger · int64Required

The ID of the media.

tag_idinteger · int64Required

The ID of the tag.

Responses
200
The media tag has been deleted.
delete
DELETE /api/public/v1/media/{media_id}/tags/{tag_id} HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Last updated

Was this helpful?