Create Revision

postapi.bunnystudio.com/revisions/{deliverableId}

This endpoint creates a revision request for a specific deliverable.

Requirements

Authentication

x-access-token

Scope

revisions

Path parameters

deliverableId

string
Bunny Studio UUID of the deliverable you want to request a revision for

Request body

instructions

string
Remarks for the revision that is requested

reason

<optional> string
Reason for the revision that is requested, only available for some categories (Audio Ads)

revisionCode

<optional> string
Code that identifies the type of revision that is requested, you can check the available codes here

checkTalent

<optional> boolean
If you need to validate first if the talent is on vacation or not, by default the value is false and the revision is posted. After that the CX team will contact you to how to proceed if the pro is on vacation

Request example

Console

 curl --request POST \ 
      --url https://api.bunnystudio.com/revisions/DELIVERABLE_ID \
      --header "Content-Type: application/json" \
      --header "x-access-token: YOUR_TOKEN" \
      --data '{
        "instructions": "Instructions for the deliverable revision",
        "reason": "both",
        "revisionCode": "quality_issues",
        "checkTalent": true,
        }'

JavaScript

  const url = 'https://api.bunnystudio.com/revisions/DELIVERABLE_ID';
  const options = {
    method: 'POST',
    headers: {
      'content-type': 'application/json',
      'x-access-token': 'YOUR_TOKEN',
    }
    body: JSON.stringify(
      {
        "instructions": "Instructions for the deliverable revision",
        "reason": "both",
        "revisionCode": "quality_issues",
        "checkTalent": true,
        }
    )
  }; 
  fetch(url, options)
    .then(response => response.json())
    .then(response => console.log(response))
    .catch(err => console.error(err));

Python

  import requests
  import json
  api_url = "https://api.bunnystudio.com/revisions/DELIVERABLE_ID"
  headers = {
    "Content-Type": "application/json; charset=utf-8",
    'x-access-token': 'YOUR_TOKEN',
  }
  body = {
   "instructions": "Instructions for the deliverable revision",
   "reason": "both",
   "revisionCode": "quality_issues",
   "checkTalent": "true",
   }
  response = requests.post(api_url, headers=headers, json=body)
  print(response.text)

PHP - CURL

<?php
  $curl = curl_init();
  curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://api.bunnystudio.com/revisions/DELIVERABLE_ID',
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => array(
      'content-type': 'application/json',
      'x-access-token': 'YOUR_TOKEN',
    ),
    CURLOPT_POSTFIELDS => '{
      "instructions": "Instructions for the deliverable revision",
      "reason": "both",
      "revisionCode": "quality_issues",
      "checkTalent": "true",
      }'
  ));
  $response = curl_exec($curl);
  curl_close($curl);
  echo $response;

Response format

id

string
A UUID (Universal Unique Identifier) that identifies the deliverable on Bunny Studio's database. You should use this ID for all API actions related to a specific deliverable.

serviceSubCategory

string
The category of this deliverable

name

string
The name of the deliverable. If it consists of multiple parts, the string will usually represent the part number (e.g. "Part 2").

status

string
The status of the deliverable

instructions

string
Remarks for the revision that is requested

reason

string
Reason for the revision that is requested, only available for some categories (Audio Ads)

revisionCode

string
Code that identifies the type of revision that is requested, you can check the available codes here

checkTalent

boolean
If you need to validate first if the talent is on vacation or not, by default the value is false and the revision is posted. After that the CX team will contact you to how to proceed if the pro is on vacation

Response example

{
  "id": "671e74ab-ca44-4d87-9346-ae8318c44774",
  "serviceSubCategory": "voice_over",
  "name": "part1",
  "status": "revisionRequested",
  "instructions": "Instructions for the deliverable revision",
  "reason": "both",
  "revisionCode": "quality_issues",
  "checkTalent": true,
}

Error responses

500 Error rejecting project

  {
    status: 500,
    type: 'ERROR_CREATING_REVISION',
    message: 'There was an error creation the revision for deliverable with id \"DELIVERABLE_ID\", please talk with our support team',
  }

400 Deliverable not exist

  {
    status: 404,
    type: 'DELIVERABLE_NO_EXIST',
    message: 'Deliverable with id \"DELIVERABLE_ID\" not found',
  }

400 Deliverable rejected

  {
    status: 404,
    type: 'DELIVERABLE_REJECTED',
    message: 'Deliverable with id \"DELIVERABLE_ID\" is already rejected',
  }

400 Deliverable already with pending revision

  {
    status: 404,
    type: 'DELIVERABLE_PENDING_REVISION',
    message: 'Deliverable with id \"DELIVERABLE_ID\" is already pending a revision',
  }

403 Forbidden

  {
    status: 403,
    type: 'FORBIDDEN',
    message: 'You do not have permission to do this action',
  }

422 Id required

  {
    status: 422,
    type: 'ID_REQUIRED',
    message: 'The field "\id\" is required',
  }

400 Talent on vacation

  {
    status: 400,
    type: 'TALENT_ON_VACATION',
    message: 'The talent will be away until \"TALENT_AWAY_END\" . It you need help please talk with our support team',
  }