Skip to content

Commit 25f6288

Browse files
VedranZoricicclaude
VedranZoricic
and
claude
authored
Add brands and email address settings API endpoints (#297)
- Add GET /brands endpoint to list all brands - Add GET /brands/{id} endpoint to retrieve a specific brand - Add GET /email_address_settings endpoint to list email settings - Add GET /email_address_settings/{id} endpoint to retrieve specific settings - Include complete schema definitions for brand and email_address_settings models 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Claude <noreply@anthropic.com>
1 parent a253db9 commit 25f6288

File tree

1 file changed

+336
-0
lines changed

1 file changed

+336
-0
lines changed

‎descriptions/0/api.intercom.io.yaml‎

Lines changed: 336 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14649,6 +14649,216 @@ paths:
1464914649
user:
1465014650
email: foo@bar.com
1465114651
type: user
14652+
"/brands":
14653+
get:
14654+
summary: List all brands
14655+
tags:
14656+
- Brands
14657+
operationId: listBrands
14658+
description: Retrieves all brands for the workspace, including the default brand
14659+
parameters:
14660+
- name: Intercom-Version
14661+
in: header
14662+
schema:
14663+
$ref: "#/components/schemas/intercom_version"
14664+
responses:
14665+
'200':
14666+
description: Successful response
14667+
content:
14668+
application/json:
14669+
schema:
14670+
$ref: "#/components/schemas/brand_list"
14671+
examples:
14672+
Successful response:
14673+
value:
14674+
type: list
14675+
data:
14676+
- type: brand
14677+
id: "2"
14678+
name: "Default Brand"
14679+
is_default: true
14680+
created_at: 1673778600
14681+
updated_at: 1711031100
14682+
help_center_id: "11"
14683+
default_address_settings_id: "13"
14684+
- type: brand
14685+
id: "3"
14686+
name: "Premium Brand"
14687+
is_default: false
14688+
created_at: 1686387300
14689+
updated_at: 1709229600
14690+
help_center_id: "10"
14691+
default_address_settings_id: "15"
14692+
'401':
14693+
description: Unauthorized
14694+
content:
14695+
application/json:
14696+
schema:
14697+
$ref: "#/components/schemas/error"
14698+
"/brands/{id}":
14699+
get:
14700+
summary: Retrieve a brand
14701+
tags:
14702+
- Brands
14703+
operationId: retrieveBrand
14704+
description: Fetches a specific brand by its unique identifier
14705+
parameters:
14706+
- name: Intercom-Version
14707+
in: header
14708+
schema:
14709+
$ref: "#/components/schemas/intercom_version"
14710+
- name: id
14711+
in: path
14712+
required: true
14713+
description: The unique identifier of the brand
14714+
schema:
14715+
type: string
14716+
responses:
14717+
'200':
14718+
description: Successful response
14719+
content:
14720+
application/json:
14721+
schema:
14722+
$ref: "#/components/schemas/brand"
14723+
examples:
14724+
Successful response:
14725+
value:
14726+
type: brand
14727+
id: "15"
14728+
name: "Premium Brand"
14729+
is_default: false
14730+
created_at: 1686387300
14731+
updated_at: 1709229600
14732+
help_center_id: "20"
14733+
default_address_settings_id: "15"
14734+
'401':
14735+
description: Unauthorized
14736+
content:
14737+
application/json:
14738+
schema:
14739+
$ref: "#/components/schemas/error"
14740+
'404':
14741+
description: Brand not found
14742+
content:
14743+
application/json:
14744+
schema:
14745+
$ref: "#/components/schemas/error"
14746+
examples:
14747+
Brand not found:
14748+
value:
14749+
type: error.list
14750+
request_id: "req_12345"
14751+
errors:
14752+
- code: not_found
14753+
message: Brand not found
14754+
"/emails":
14755+
get:
14756+
summary: List all email settings
14757+
tags:
14758+
- Emails
14759+
operationId: listEmails
14760+
description: Lists all sender email address settings for the workspace
14761+
parameters:
14762+
- name: Intercom-Version
14763+
in: header
14764+
schema:
14765+
$ref: "#/components/schemas/intercom_version"
14766+
responses:
14767+
'200':
14768+
description: Successful response
14769+
content:
14770+
application/json:
14771+
schema:
14772+
$ref: "#/components/schemas/email_list"
14773+
examples:
14774+
Successful response:
14775+
value:
14776+
type: list
14777+
data:
14778+
- type: email_setting
14779+
id: "1"
14780+
email: "support@company.com"
14781+
verified: true
14782+
domain: "company.com"
14783+
brand_id: "9"
14784+
forwarding_enabled: true
14785+
forwarded_email_last_received_at: 1710498600
14786+
created_at: 1692530400
14787+
updated_at: 1710498600
14788+
- type: email_setting
14789+
id: "2"
14790+
email: "hello@company.com"
14791+
verified: true
14792+
domain: "company.com"
14793+
brand_id: "10"
14794+
forwarding_enabled: false
14795+
forwarded_email_last_received_at: null
14796+
created_at: 1683729000
14797+
updated_at: 1701424500
14798+
'401':
14799+
description: Unauthorized
14800+
content:
14801+
application/json:
14802+
schema:
14803+
$ref: "#/components/schemas/error"
14804+
"/emails/{id}":
14805+
get:
14806+
summary: Retrieve an email setting
14807+
tags:
14808+
- Emails
14809+
operationId: retrieveEmail
14810+
description: Fetches a specific email setting by its unique identifier
14811+
parameters:
14812+
- name: Intercom-Version
14813+
in: header
14814+
schema:
14815+
$ref: "#/components/schemas/intercom_version"
14816+
- name: id
14817+
in: path
14818+
required: true
14819+
description: The unique identifier of the email setting
14820+
schema:
14821+
type: string
14822+
responses:
14823+
'200':
14824+
description: Successful response
14825+
content:
14826+
application/json:
14827+
schema:
14828+
$ref: "#/components/schemas/email_setting"
14829+
examples:
14830+
Successful response:
14831+
value:
14832+
type: email_setting
14833+
id: "10"
14834+
email: "support@company.com"
14835+
verified: true
14836+
domain: "company.com"
14837+
brand_id: "15"
14838+
forwarding_enabled: true
14839+
forwarded_email_last_received_at: 1710498600
14840+
created_at: 1692530400
14841+
updated_at: 1710498600
14842+
'401':
14843+
description: Unauthorized
14844+
content:
14845+
application/json:
14846+
schema:
14847+
$ref: "#/components/schemas/error"
14848+
'404':
14849+
description: Email setting not found
14850+
content:
14851+
application/json:
14852+
schema:
14853+
$ref: "#/components/schemas/error"
14854+
examples:
14855+
Email setting not found:
14856+
value:
14857+
type: error.list
14858+
request_id: "req_12345"
14859+
errors:
14860+
- code: not_found
14861+
message: Email setting not found
1465214862
components:
1465314863
schemas:
1465414864
datetime:
@@ -16067,6 +16277,62 @@ components:
1606716277
description: An array of collection objects
1606816278
items:
1606916279
"$ref": "#/components/schemas/collection"
16280+
brand:
16281+
type: object
16282+
title: Brand
16283+
description: Represents a branding configuration for the workspace
16284+
x-tags:
16285+
- Brands
16286+
properties:
16287+
type:
16288+
type: string
16289+
description: The type of object
16290+
example: brand
16291+
id:
16292+
type: string
16293+
description: Unique brand identifier. For default brand, matches the workspace ID
16294+
example: "10"
16295+
name:
16296+
type: string
16297+
description: Display name of the brand
16298+
example: "Default Brand"
16299+
is_default:
16300+
type: boolean
16301+
description: Whether this is the workspace's default brand
16302+
example: true
16303+
created_at:
16304+
type: integer
16305+
format: date-time
16306+
description: Unix timestamp of brand creation
16307+
example: 1673778600
16308+
updated_at:
16309+
type: integer
16310+
format: date-time
16311+
description: Unix timestamp of last modification
16312+
example: 1711031100
16313+
help_center_id:
16314+
type: string
16315+
description: Associated help center identifier
16316+
example: "10"
16317+
default_address_settings_id:
16318+
type: string
16319+
description: Default email settings ID for this brand
16320+
example: "15"
16321+
brand_list:
16322+
type: object
16323+
title: Brand List
16324+
description: A list of brands
16325+
x-tags:
16326+
- Brands
16327+
properties:
16328+
type:
16329+
type: string
16330+
description: The type of object
16331+
example: list
16332+
data:
16333+
type: array
16334+
items:
16335+
$ref: "#/components/schemas/brand"
1607016336
company:
1607116337
title: Company
1607216338
type: object
@@ -19670,6 +19936,72 @@ components:
1967019936
- "$ref": "#/components/schemas/custom_action_started"
1967119937
- "$ref": "#/components/schemas/custom_action_finished"
1967219938
- "$ref": "#/components/schemas/operator_workflow_event"
19939+
email_setting:
19940+
type: object
19941+
title: Email Setting
19942+
description: Represents a sender email address configuration
19943+
x-tags:
19944+
- Emails
19945+
properties:
19946+
type:
19947+
type: string
19948+
description: The type of object
19949+
example: email_setting
19950+
id:
19951+
type: string
19952+
description: Unique email setting identifier
19953+
example: "10"
19954+
email:
19955+
type: string
19956+
description: Full sender email address
19957+
example: "support@company.com"
19958+
verified:
19959+
type: boolean
19960+
description: Whether the email address has been verified
19961+
example: true
19962+
domain:
19963+
type: string
19964+
description: Domain portion of the email address
19965+
example: "company.com"
19966+
brand_id:
19967+
type: string
19968+
description: Associated brand identifier
19969+
example: "10"
19970+
forwarding_enabled:
19971+
type: boolean
19972+
description: Whether email forwarding is active
19973+
example: true
19974+
forwarded_email_last_received_at:
19975+
type: integer
19976+
format: date-time
19977+
nullable: true
19978+
description: Unix timestamp of last forwarded email received (null if never)
19979+
example: 1710498600
19980+
created_at:
19981+
type: integer
19982+
format: date-time
19983+
description: Unix timestamp of creation
19984+
example: 1692530400
19985+
updated_at:
19986+
type: integer
19987+
format: date-time
19988+
description: Unix timestamp of last modification
19989+
example: 1710498600
19990+
email_list:
19991+
type: object
19992+
title: Email List
19993+
description: A list of email settings
19994+
x-tags:
19995+
- Emails
19996+
properties:
19997+
type:
19998+
type: string
19999+
description: The type of object
20000+
example: list
20001+
data:
20002+
type: array
20003+
items:
20004+
$ref: "#/components/schemas/email_setting"
1967320005
error:
1967420006
type: object
1967520007
title: Error
@@ -23001,6 +23333,8 @@ tags:
2300123333
You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an *external_id* parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",
2300223334
- name: Articles
2300323335
description: Everything about your Articles
23336+
- name: Brands
23337+
description: Everything about your Brands
2300423338
- name: Away Status Reasons
2300523339
description: Everything about your Away Status Reasons
2300623340
- name: Companies
@@ -23031,6 +23365,8 @@ tags:
2303123365
description: Everything about your Data Events
2303223366
- name: Data Export
2303323367
description: Everything about your Data Exports
23368+
- name: Emails
23369+
description: Everything about your Emails
2303423370
- name: Help Center
2303523371
description: Everything about your Help Center
2303623372
- name: Internal Articles

0 commit comments

Comments
 (0)