latestOpenAPI 3.1.02026-08-233001841.3 MB
0dcf3303e9d7
exports
Export opportunities, based on opportunity filters
Parameters:
- params (optional) - A dictionary of filters, which would be used for the /opportunity/ endpoint.
- format - Format of the exported file. The choices are: csv, json
- date_format (optional) - Controls the format of date objects. Note: this only works with the csv format.
- original (default) - A date format that includes microseconds and timezone information.
- Date: [YYYY]-[MM]-[DD]
- Date w/ time: [YYYY]-[MM]-[DD] [hh]:[mm]:[ss.sssss]±[hh]:[mm]
- iso8601 (recommended) - An ISO 8601 compatible date representation that does not include microseconds.
- Date: [YYYY]-[MM]-[DD]
- Date w/ time: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]±[hh]:[mm]
- excel - An Excel compatible date format. Dates are always in UTC, do not include timezone information or microseconds, and use a 12 hour clock with an AM or PM designation.
- Date: [YYYY]-[MM]-[DD]
- Date w/ time: [YYYY]-[MM]-[DD] [hh]:[mm]:[ss] [AM|PM]
- original (default) - A date format that includes microseconds and timezone information.
- fields (optional) - By default we return all the data fields. If you only need specific fields exported, you can explicitly list them in fields to get smaller exports.
- send_done_email - Set to false if you don't want to get a confirmation email after the bulk action is done.
post/export/opportunity/
Response
Successful response