IOionworks
Sites

Update a specific site by id

Changed on

Update an existing site identified by its ID.

Only provided fields will be updated.

patch/sites/{site_id}

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/sites/{site_id}
  • Auth
    none declared

Path parameters

site_idstring uuid required

Request body

object required

Response

Successful Response

namestring required

Name of the site

locationstring nullable

Physical location of the site (e.g. address or lab name)

notesstring nullable

Free-text notes about the site

timezonestring

IANA time zone name of the site's local wall clock (e.g. America/New_York)

idstring required

Unique identifier for the site

organization_idstring required

Organization this site belongs to.

created_bystring nullable

User ID of the user who created this site

created_by_emailstring nullable

Email of the user who created this site

created_atstring date-time required

Timestamp when the site was created

updated_atstring date-time required

Timestamp when the site was last updated

cycler_idsobject[] nullable

List of cycler IDs belonging to this site

Changes