Photo mockups

Update an existing photo mockup

Rename a mockup and/or set the colours it answers to by name. A render may then send a name where it would send a hex code.

patch/api/v1/sudoai/2d-mockups/{mockup_id}

Request

  • Base URL: https://api.sudomock.com
  • URL: https://api.sudomock.com/api/v1/sudoai/2d-mockups/{mockup_id}
  • Auth: API key in header x-api-key

Path parameters

mockup_idstring required

Id of the photo mockup to rename or give named colours.

Request body

namestring nullable

New mockup name

Example request

{
  "name": "Updated Mockup Name"
}

Response

Successful Response

successtrue

Always true on a successful response.

Example response

{
  "data": {
    "colors": [
      {
        "hex": "#6A8296",
        "label": "blue jean"
      },
      {
        "hex": "#E4DED3",
        "label": "bone"
      }
    ],
    "name": "Front view",
    "uuid": "893ea326-278b-480b-b130-87dd6aee06dc"
  },
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.