Update a context image

patch

https://api.lingohub.com/v2/context-images/{contextImageId}

Partially updates the context image identified by the given ID (JSON merge-patch). Only fields present in the request body are changed; omitted fields are left unchanged and an explicit description: null clears the description (name cannot be null). Returns the full updated context image. Requires project-level context-image management permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

contextImageId

string

required

^ci_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Unique identifier of the context image.

Body Params

Request body to partially update a context image (PATCH, JSON merge-patch). Only fields present in the request body are changed; omitted fields are left unchanged and an explicit description: null clears the description. name cannot be null.

name

string

length ≤ 4096

Display name of the context image.

description

string | null

Description of what the image shows. An explicit null clears it.

Headers

If-Match

string

Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Context image updated successfully.

400The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. code names the problem, errors the parameter or field.

401Invalid or missing API key.

403Insufficient permissions.

404Context image not found.

412The current representation does not match If-Match (precondition_failed). No change was applied.

422Validation error.

429The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.

500An unexpected internal server error occurred.

503The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.