Skip to content

Commit bbe8bfa

Browse files
authored
Add clarifying note to listSubscriptionsForAContact across all versions (#561)
The endpoint description now explicitly states that only subscriptions where the contact has made an explicit opt-in or opt-out choice are returned. Subscriptions in the default state are not included. - intercom/developer-docs#989
1 parent bb810ac commit bbe8bfa

9 files changed

Lines changed: 18 additions & 0 deletions

File tree

descriptions/2.10/api.intercom.io.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2652,6 +2652,8 @@ paths:
26522652

26532653
1.Opt-out subscription types that the user has opted-out from.
26542654
2.Opt-in subscription types that the user has opted-in to receiving.
2655+
2656+
**Note:** This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response.
26552657
responses:
26562658
'200':
26572659
description: Successful

descriptions/2.11/api.intercom.io.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2732,6 +2732,8 @@ paths:
27322732

27332733
1.Opt-out subscription types that the user has opted-out from.
27342734
2.Opt-in subscription types that the user has opted-in to receiving.
2735+
2736+
**Note:** This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response.
27352737
responses:
27362738
'200':
27372739
description: Successful

descriptions/2.12/api.intercom.io.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3241,6 +3241,8 @@ paths:
32413241

32423242
1.Opt-out subscription types that the user has opted-out from.
32433243
2.Opt-in subscription types that the user has opted-in to receiving.
3244+
3245+
**Note:** This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response.
32443246
responses:
32453247
'200':
32463248
description: Successful

descriptions/2.13/api.intercom.io.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3654,6 +3654,8 @@ paths:
36543654

36553655
1.Opt-out subscription types that the user has opted-out from.
36563656
2.Opt-in subscription types that the user has opted-in to receiving.
3657+
3658+
**Note:** This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response.
36573659
responses:
36583660
'200':
36593661
description: Successful

descriptions/2.14/api.intercom.io.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4465,6 +4465,8 @@ paths:
44654465

44664466
1.Opt-out subscription types that the user has opted-out from.
44674467
2.Opt-in subscription types that the user has opted-in to receiving.
4468+
4469+
**Note:** This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response.
44684470
responses:
44694471
'200':
44704472
description: Successful

descriptions/2.15/api.intercom.io.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4536,6 +4536,8 @@ paths:
45364536

45374537
1.Opt-out subscription types that the user has opted-out from.
45384538
2.Opt-in subscription types that the user has opted-in to receiving.
4539+
4540+
**Note:** This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response.
45394541
responses:
45404542
'200':
45414543
description: Successful

descriptions/2.7/api.intercom.io.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2871,6 +2871,8 @@ paths:
28712871

28722872
1.Opt-out subscription types that the user has opted-out from.
28732873
2.Opt-in subscription types that the user has opted-in to receiving.
2874+
2875+
**Note:** This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response.
28742876
responses:
28752877
'200':
28762878
description: Successful

descriptions/2.8/api.intercom.io.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2871,6 +2871,8 @@ paths:
28712871

28722872
1.Opt-out subscription types that the user has opted-out from.
28732873
2.Opt-in subscription types that the user has opted-in to receiving.
2874+
2875+
**Note:** This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response.
28742876
responses:
28752877
'200':
28762878
description: Successful

descriptions/2.9/api.intercom.io.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2871,6 +2871,8 @@ paths:
28712871

28722872
1.Opt-out subscription types that the user has opted-out from.
28732873
2.Opt-in subscription types that the user has opted-in to receiving.
2874+
2875+
**Note:** This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response.
28742876
responses:
28752877
'200':
28762878
description: Successful

0 commit comments

Comments
 (0)