Home
/
REST API Reference
/
Contacts
/
Remove subscription from a contact

Remove subscription from a contact

You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.

SecurityHTTP: bearerAuth
Request
path Parameters
contact_id
required
string

The unique identifier for the contact which is given by Intercom

Example: 63a07ddf05a32042dffac965
id
required
string

The unique identifier for the subscription type which is given by Intercom

Example: 37846
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "Unstable"
Example: 2.10
delete
/contacts/{contact_id}/subscriptions/{id}
Request samples
Responses
200
Successful
Response Schema: application/json
type
string 
The type of the object - subscription
 
id
string 
The unique identifier representing the subscription type.
 
state
string 
The state of the subscription type.
 Enum: "live" "draft" "archived"  
object (Translation)  
A translation object contains the localised details of a subscription type.
 
Array of objects (Translation)  
An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.
 
consent_type
string 
Describes the type of consent.
 Enum: "opt_out" "opt_in"  
content_types
Array of strings 
The message types that this subscription supports - can contain email or sms_message.
Items Enum: "email" "sms_message"  
401
Unauthorized
404
Resource not found
Response samples
application/json
{
"type": "subscription",
"id": "1592",
"state": "live",
"consent_type": "opt_in",
"default_translation": {
"name": "Newsletters",
"description": "Lorem ipsum dolor sit amet",
"locale": "en"
},
"translations": [

],
"content_types": [
"sms_message"
]
}