Skip to content

Commit 8cd83dd

Browse files
authored
add block contact API to unstable version (#202)
1 parent cd8060c commit 8cd83dd

File tree

1 file changed

+50
-80
lines changed

1 file changed

+50
-80
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 50 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -4040,13 +4040,6 @@ paths:
40404040
description: successful
40414041
content:
40424042
application/json:
4043-
examples:
4044-
successful:
4045-
value:
4046-
id: 6762f0d21bb69f9f2193bb7e
4047-
external_id: '70'
4048-
type: contact
4049-
deleted: true
40504043
schema:
40514044
"$ref": "#/components/schemas/contact_deleted"
40524045
'401':
@@ -4717,13 +4710,6 @@ paths:
47174710
description: successful
47184711
content:
47194712
application/json:
4720-
examples:
4721-
successful:
4722-
value:
4723-
id: 6762f0e21bb69f9f2193bb86
4724-
external_id: '70'
4725-
type: contact
4726-
archived: true
47274713
schema:
47284714
"$ref": "#/components/schemas/contact_archived"
47294715
"/contacts/{id}/unarchive":
@@ -4750,15 +4736,34 @@ paths:
47504736
description: successful
47514737
content:
47524738
application/json:
4753-
examples:
4754-
successful:
4755-
value:
4756-
id: 6762f0e31bb69f9f2193bb87
4757-
external_id: '70'
4758-
type: contact
4759-
archived: false
47604739
schema:
47614740
"$ref": "#/components/schemas/contact_unarchived"
4741+
"/contacts/{id}/block":
4742+
post:
4743+
summary: Block contact
4744+
parameters:
4745+
- name: Intercom-Version
4746+
in: header
4747+
schema:
4748+
"$ref": "#/components/schemas/intercom_version"
4749+
- name: id
4750+
in: path
4751+
description: id
4752+
example: 63a07ddf05a32042dffac965
4753+
required: true
4754+
schema:
4755+
type: string
4756+
tags:
4757+
- Contacts
4758+
operationId: BlockContact
4759+
description: You can block a single contact.
4760+
responses:
4761+
'200':
4762+
description: successful
4763+
content:
4764+
application/json:
4765+
schema:
4766+
"$ref": "#/components/schemas/contact_blocked"
47624767
"/conversations/{conversation_id}/tags":
47634768
post:
47644769
summary: Add tag to a conversation
@@ -14153,30 +14158,6 @@ components:
1415314158
"$ref": "#/components/schemas/contact_location"
1415414159
social_profiles:
1415514160
"$ref": "#/components/schemas/contact_social_profiles"
14156-
contact_archived:
14157-
title: Contact Archived
14158-
type: object
14159-
description: archived contact object
14160-
properties:
14161-
type:
14162-
type: string
14163-
description: always contact
14164-
enum:
14165-
- contact
14166-
example: contact
14167-
id:
14168-
type: string
14169-
description: The unique identifier for the contact which is given by Intercom.
14170-
example: 5ba682d23d7cf92bef87bfd4
14171-
external_id:
14172-
type: string
14173-
nullable: true
14174-
description: The unique identifier for the contact which is provided by
14175-
the Client.
14176-
example: f3b87a2e09d514c6c2e79b9a
14177-
archived:
14178-
type: boolean
14179-
description: Whether the contact is archived or not.
1418014161
example: true
1418114162
contact_attached_companies:
1418214163
title: Contact Attached Companies
@@ -14224,25 +14205,10 @@ components:
1422414205
example: true
1422514206
contact_deleted:
1422614207
title: Contact Deleted
14227-
type: object
1422814208
description: deleted contact object
14209+
allOf:
14210+
- "$ref": "#/components/schemas/contact_reference"
1422914211
properties:
14230-
type:
14231-
type: string
14232-
description: always contact
14233-
enum:
14234-
- contact
14235-
example: contact
14236-
id:
14237-
type: string
14238-
description: The unique identifier for the contact which is given by Intercom.
14239-
example: 5ba682d23d7cf92bef87bfd4
14240-
external_id:
14241-
type: string
14242-
nullable: true
14243-
description: The unique identifier for the contact which is provided by
14244-
the Client.
14245-
example: f3b87a2e09d514c6c2e79b9a
1424614212
deleted:
1424714213
type: boolean
1424814214
description: Whether the contact is deleted or not.
@@ -14342,7 +14308,7 @@ components:
1434214308
nullable: true
1434314309
description: The unique identifier for the contact which is provided by
1434414310
the Client.
14345-
example: f3b87a2e09d514c6c2e79b9a
14311+
example: "70"
1434614312
contact_reply_base_request:
1434714313
title: Contact Reply Base Object
1434814314
type: object
@@ -14564,31 +14530,35 @@ components:
1456414530
description: Whether there's more Addressable Objects to be viewed. If true,
1456514531
use the url to view all
1456614532
example: true
14533+
contact_archived:
14534+
title: Contact Archived
14535+
description: archived contact object
14536+
allOf:
14537+
- "$ref": "#/components/schemas/contact_reference"
14538+
properties:
14539+
archived:
14540+
type: boolean
14541+
description: Whether the contact is archived or not.
1456714542
contact_unarchived:
1456814543
title: Contact Unarchived
14569-
type: object
1457014544
description: unarchived contact object
14545+
allOf:
14546+
- "$ref": "#/components/schemas/contact_reference"
1457114547
properties:
14572-
type:
14573-
type: string
14574-
description: always contact
14575-
enum:
14576-
- contact
14577-
example: contact
14578-
id:
14579-
type: string
14580-
description: The unique identifier for the contact which is given by Intercom.
14581-
example: 5ba682d23d7cf92bef87bfd4
14582-
external_id:
14583-
type: string
14584-
nullable: true
14585-
description: The unique identifier for the contact which is provided by
14586-
the Client.
14587-
example: f3b87a2e09d514c6c2e79b9a
1458814548
archived:
1458914549
type: boolean
1459014550
description: Whether the contact is archived or not.
1459114551
example: false
14552+
contact_blocked:
14553+
title: Contact Blocked
14554+
description: blocked contact object
14555+
allOf:
14556+
- "$ref": "#/components/schemas/contact_reference"
14557+
properties:
14558+
blocked:
14559+
type: boolean
14560+
description: Always true.
14561+
example: true
1459214562
content_import_source:
1459314563
title: Content Import Source
1459414564
type: object

0 commit comments

Comments
 (0)