Update a tag

Update tag

Updating a single tag is done by sending a PATCH request to the /tags/:id endpoint.

Writable fields are title, slug, and description.

CURL


curl -X PATCH https://app.ignitevideo.cloud/api/tags/[TAG_ID] \ 
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"title": "New tag title"}'

JavaScript / Node.js


const dataToUpdate = {
  "title": "New tag title"
}
const response = await fetch(`https://app.ignitevideo.cloud/api/tags/[TAG_ID]`, {
  method: 'PATCH',
  body: JSON.stringify(dataToUpdate),
  headers: {
    'Authorization': `Bearer YOUR_TOKEN`,
    'Content-Type': 'application/json'
  }
});

PHP


$client = new GuzzleHttp\Client();
$dataToUpdate = [
  "title" => "New tag title"
];
$response = $client->request('PATCH', 'https://app.ignitevideo.cloud/api/tags/[TAG_ID]', [
  'body' => json_encode($dataToUpdate),
  'headers' => [
    'Authorization' => 'Bearer YOUR_TOKEN',
    'Content-Type' => 'application/json'
  ]
]);

Response

The response is an object containing the tag object and an update message. If the id does not exist, the response is 403 with the Payload error. A missing id and a forbidden id return the same body. See Authentication.


{
  doc: {
    "id": "[TAG_ID]",
    "title": "New tag title",
    ...
  },
  message: "Updated successfully."
}