Skip to main content
    Ivy Biosciences Docs/Call the platform/API/Reference/Reference/Jobs/PATCH /v1/jobs/{jobId}/plate

    PATCH /v1/jobs/{jobId}/plate

    Save wells on a job's plate (PATCH)

    Auth: required. Send an ivy_ API key (Authorization: Bearer ivy_… or X-Ivy-Api-Key), a Clerk session JWT (Authorization: Bearer …) or the Clerk __session cookie (browser sessions). See Authentication.

    Does exactly what POST on this path does: the same body, the same behavior and the same responses. See updateJobPlate.

    Request

    Path parameters

    jobIdstring (uuid)

    UUID of the job.

    Request body

    updatesobject[]

    Wells to save. Must contain at least one entry with a numeric row and col.

    Responses

    200 OK

    The wells were saved

    Response shape:

    successenum (true)
    upsertedinteger

    Number of wells saved.

    manifestEventWrittenboolean

    Whether the plate-update event was appended to the job's manifest. The wells are saved either way.

    400 Bad Request

    Same conditions as POST

    Response shape: object

    401 Unauthorized

    Authentication required

    Response shape: object

    404 Not Found

    The job does not exist, you cannot write to it (a project viewer cannot), it is outside your API key's project scope, or the id is not a job UUID. All of these return the same body.

    Response shape: object

    429 Too Many Requests

    Rate limit exceeded

    Response shape: object

    500 Internal Server Error

    The job row could not be loaded, or saving failed

    Response shape: object

    curl -X PATCH 'https://ivybiosciences.com/api/v1/jobs/{jobId}/plate' \
      -H "Authorization: Bearer $IVY_API_KEY" \
      -H 'Content-Type: application/json' \
      -d '{
      "updates": [
        {
          "row": 0,
          "col": 0
        }
      ]
    }'

    Was this page helpful?

    Loading...