File links
Last updated
2020-01-07
Last updated
File Links provide a secure and convenient way to share the contents of a File object with customers by generating a unique URL. This URL allows customers to access the file's content without requiring authentication. File Links are particularly useful for sharing documents, invoices, or other files associated with order management, enhancing the customer experience by simplifying access to important information.
Retrieves the details of a file link. You must supply the unique identifier of the file link.
The identifier of the file link to be retrieved.
Permanently deletes a file link. Supply the unique identifier of the file link.
FileLink ID
No content
Gets all the file links specified in the request.
A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
Only return objects with these IDs.
Only return links with this file identifier.
Filter links by expired state. By default, all links are returned.
Creates a new file link object.
The identifier of the file to create a link to.
file_b9bb0bce-c20e-4519-945e-45983a1b239bA future timestamp, after which the link will no longer be usable.
Updates an existing file link. Expired links can no longer be updated.
The identifier of the file link to be updated.
A future timestamp, after which the link will no longer be usable.