@@ -1747,6 +1747,74 @@ paths:
17471747 $ref: "#/components/schemas/away_status_reason"
17481748 '401':
17491749 "$ref": "#/components/responses/Unauthorized"
1750+ "/audiences":
1751+ get:
1752+ summary: List all audiences
1753+ parameters:
1754+ - name: Intercom-Version
1755+ in: header
1756+ schema:
1757+ "$ref": "#/components/schemas/intercom_version"
1758+ - name: page
1759+ in: query
1760+ required: false
1761+ description: The page of results to fetch. Defaults to first page.
1762+ example: 1
1763+ schema:
1764+ type: integer
1765+ - name: per_page
1766+ in: query
1767+ required: false
1768+ description: The number of results to return per page. Defaults to 50. Maximum
1769+ is 50.
1770+ example: 50
1771+ schema:
1772+ type: integer
1773+ maximum: 50
1774+ tags:
1775+ - Audiences
1776+ operationId: listAudiences
1777+ description: You can fetch a list of all audiences for the workspace.
1778+ responses:
1779+ '200':
1780+ description: Successful response
1781+ content:
1782+ application/json:
1783+ examples:
1784+ Successful response:
1785+ value:
1786+ type: list
1787+ data:
1788+ - type: audience
1789+ id: '123'
1790+ name: VIP Customers
1791+ created_at: 1717200000
1792+ updated_at: 1717200000
1793+ - type: audience
1794+ id: '456'
1795+ name: Enterprise Accounts
1796+ created_at: 1717200000
1797+ updated_at: 1717200000
1798+ total_count: 2
1799+ page: 1
1800+ per_page: 50
1801+ total_pages: 1
1802+ schema:
1803+ "$ref": "#/components/schemas/audience_list"
1804+ '401':
1805+ description: Unauthorized
1806+ content:
1807+ application/json:
1808+ examples:
1809+ Unauthorized:
1810+ value:
1811+ type: error.list
1812+ request_id: b1939528-98f0-4a63-a442-2cc9203fc8c7
1813+ errors:
1814+ - code: unauthorized
1815+ message: Access Token Invalid
1816+ schema:
1817+ "$ref": "#/components/schemas/error"
17501818 "/export/reporting_data/enqueue":
17511819 post:
17521820 summary: Enqueue a new reporting data export job
@@ -19312,6 +19380,68 @@ components:
1931219380 type: boolean
1931319381 description: Whether or not the app uses identity verification.
1931419382 example: false
19383+ audience:
19384+ title: Audience
19385+ type: object
19386+ x-tags:
19387+ - Audiences
19388+ description: An audience represents a group of contacts that can be targeted
19389+ by Fin.
19390+ properties:
19391+ type:
19392+ type: string
19393+ description: The type of object.
19394+ enum:
19395+ - audience
19396+ example: audience
19397+ id:
19398+ type: string
19399+ description: The unique identifier representing the audience.
19400+ example: '123'
19401+ name:
19402+ type: string
19403+ description: The name of the audience.
19404+ example: VIP Customers
19405+ created_at:
19406+ type: integer
19407+ description: The time the audience was created as a Unix timestamp.
19408+ example: 1717200000
19409+ updated_at:
19410+ type: integer
19411+ description: The time the audience was last updated as a Unix timestamp.
19412+ example: 1717200000
19413+ audience_list:
19414+ title: Audience List
19415+ type: object
19416+ description: A paginated list of audience objects.
19417+ properties:
19418+ type:
19419+ type: string
19420+ description: The type of the object.
19421+ enum:
19422+ - list
19423+ example: list
19424+ data:
19425+ type: array
19426+ description: A list of audience objects.
19427+ items:
19428+ "$ref": "#/components/schemas/audience"
19429+ total_count:
19430+ type: integer
19431+ description: The total number of audiences.
19432+ example: 2
19433+ page:
19434+ type: integer
19435+ description: The current page number.
19436+ example: 1
19437+ per_page:
19438+ type: integer
19439+ description: The number of results per page.
19440+ example: 50
19441+ total_pages:
19442+ type: integer
19443+ description: The total number of pages.
19444+ example: 1
1931519445 article:
1931619446 title: Article
1931719447 type: object
@@ -29904,6 +30034,8 @@ tags:
2990430034 description: Everything about your Articles
2990530035- name: Away Status Reasons
2990630036 description: Everything about your Away Status Reasons
30037+ - name: Audiences
30038+ description: Everything about your Audiences
2990730039- name: Brands
2990830040 description: Everything about your Brands
2990930041- name: Calls
0 commit comments