Update Image

PATCH

/api/v1/workspaces/{workspace_id}/images/{id}

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/images/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"New Name","archived":false}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/images/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "New Name", "archived": false }'

Updates an image.

Authorizations

OAuth2
image_library:write

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

required

string

Image ID

Request Body

application/json

object

name

string

Example

New Name

archived

boolean

Example

false

Responses

200

Successful

application/json

object

required

string

name

required

string

filename

required

string

width

required

integer

height

required

integer

file_size

required

integer

created_at

required

string format: date-time

updated_at

required

string format: date-time

organization_id

required

integer

public_url

required

string

description

required

string

nullable

extension

required

string

archived

required

boolean

Example

{
  "id": "bd1c1b82-1a7b-4f0f-b079-30c1d4189bed",
  "name": "My Image",
  "filename": "image.png",
  "width": 100,
  "height": 100,
  "file_size": 1000,
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z",
  "organization_id": 12345,
  "public_url": "https://www.example.com/image.png",
  "description": "A beautiful image of a cat",
  "extension": "png",
  "archived": false
}

401

Unauthorized

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

404

Not Found

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

422

Unprocessable Entity

application/json

object

message

required

string

errors

required

object

key

additional properties

Array<string>

Example

{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}