client.media.put_spot_orders_archive

A method of the Media endpoint.

put_spot_orders_archive(id: int, status: bool) Response

Update the archive status of this object

API URL: PUT /media/spot_orders/{id}/archive

import civis
client = civis.APIClient()
response = client.media.put_spot_orders_archive(...)
Parameters:
idint

The ID of the object.

statusbool

The desired archived status of the object.

Returns:
civis.Response
  • idint

    The ID for the spot order.

  • archivedbool

    The archival status of the requested item(s).

  • csv_s3_uristr

    S3 URI for the spot order CSV file.

  • json_s3_uristr

    S3 URI for the spot order JSON file.

  • xml_archive_s3_uristr

    S3 URI for the spot order XML archive.

  • last_transform_job_idint

    ID of the spot order transformation job.