civis.io.json_to_file
- civis.io.json_to_file(obj, name='file.json', expires_at='DEFAULT', client=None, **json_kwargs)[source]
Store a JSON-serializable object in a Civis File
- Parameters:
- obj
The object to be JSON-serialized and stored in a Civis File
- namestr, optional
The name of the Civis File
- expires_atstr, optional
The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify
None. To specify a date and time, format it by the ISO 8601 standard, e.g.,"2020-12-31","2020-12-31T23:03:40Z", and what theisoformat()method returns from adatetime.dateordatetime.datetimeobject.- client
civis.APIClient, optional If not provided, an
civis.APIClientobject will be created from theCIVIS_API_KEY.- **json_kwargs
Additional keyword arguments will be passed directly to
json.dump().
- Returns:
- file_idint
The integer ID of the new Civis File object
See also