Skip to content

Commit 71def27

Browse files
committed
Update Update company with new request payload type
1 parent 29c6d6f commit 71def27

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

descriptions/2.14/api.intercom.io.yaml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2955,6 +2955,21 @@ paths:
29552955
{% admonition type="warning" name="Using `company_id`" %}
29562956
When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.
29572957
{% /admonition %}
2958+
requestBody:
2959+
content:
2960+
application/json:
2961+
schema:
2962+
"$ref": "#/components/schemas/update_company_request"
2963+
examples:
2964+
successful:
2965+
summary: Successful
2966+
value:
2967+
name: my company
2968+
website: http://www.mycompany.com/
2969+
bad_request:
2970+
summary: Bad Request
2971+
value:
2972+
test: invalid
29582973
responses:
29592974
'200':
29602975
description: Successful
@@ -17785,6 +17800,50 @@ components:
1778517800
155.98 will be truncated to 155. Note that this has an upper limit of
1778617801
2**31-1 or 2147483647..
1778717802
example: 1000
17803+
update_company_request:
17804+
type: object
17805+
title: Update Company Request Payload
17806+
description: You can update a Company
17807+
nullable: true
17808+
properties:
17809+
name:
17810+
type: string
17811+
description: The name of the Company
17812+
example: Intercom
17813+
plan:
17814+
type: string
17815+
description: The name of the plan you have associated with the company.
17816+
example: Enterprise
17817+
size:
17818+
type: integer
17819+
description: The number of employees in this company.
17820+
example: '100'
17821+
website:
17822+
type: string
17823+
description: The URL for this company's website. Please note that the value
17824+
specified here is not validated. Accepts any string.
17825+
example: https://www.example.com
17826+
industry:
17827+
type: string
17828+
description: The industry that this company operates in.
17829+
example: Manufacturing
17830+
custom_attributes:
17831+
type: object
17832+
description: A hash of key/value pairs containing any other data about the
17833+
company you want Intercom to store.
17834+
additionalProperties:
17835+
type: string
17836+
example:
17837+
paid_subscriber: true
17838+
monthly_spend: 155.5
17839+
team_mates: 9
17840+
monthly_spend:
17841+
type: integer
17842+
description: How much revenue the company generates for your business. Note
17843+
that this will truncate floats. i.e. it only allow for whole integers,
17844+
155.98 will be truncated to 155. Note that this has an upper limit of
17845+
2**31-1 or 2147483647..
17846+
example: 1000
1778817847
create_or_update_custom_object_instance_request:
1778917848
description: Payload to create or update a Custom Object instance
1779017849
type: object

0 commit comments

Comments
 (0)