Jump to Content
Home
Guides
API Reference
v1.1
API Reference
v1.1
Home
Guides
API Reference
Email Unsubscribe
Search
JUMP TO
Number Validation API
Number Validation
numbervalidation
get
Number Lookup
numberlookup
get
Capability Check API
Capability Check
capabilitycheck
get
Bulk Capability Check
bulkcapabilitycheck
post
Channels API
ApiSettings
Gets the gateway product tokens.
get
Get the API keys for the logical account.
get
Determines if the Account ID has Messaging Capability.
get
Get whitelisted numbers linked to logical account, if null, no whitelist is active.
get
Send test message
post
Gets the business messaging entity events.
get
Gets the ip restriction configuration.
get
Updates the ip restriction configuration.
put
Adds the ip restriction configuration.
post
Deletes the ip restriction configuration.
delete
Gets the ip restriction suggestions.
get
Gets the mt recipient available country filters.
get
Gets the mt recipient country filter configuration.
get
Updates the mt recipient country filter configuration.
put
Adds the mt recipient country filter configuration.
post
Deletes the mt recipient country filter configuration.
delete
Gets the default mt recipient country filter configuration.
get
Gets the rate limiting configuration.
get
Updates the rate limiting configuration.
put
Creates the rate limiting configuration.
post
Deletes the rate limiting configuration.
delete
Gets the rate limiting accepted time units.
get
Gets the SMPP configurations.
get
Gets the SMPP configuration.
get
Gets the sr webhook configuration.
get
Puts the sr webhook configuration.
put
Posts the sr webhook configuration.
post
Deletes the sr webhook configuration.
delete
Deprecated.
get
Deprecated.
get
Deprecated.
get
Deprecated.
put
Deprecated.
post
Deprecated.
delete
Deprecated.
get
Deprecated.
get
Deprecated.
get
Deprecated.
post
AppleBusinessChat
Gets the account.
get
Add an abc account.
post
Gets the account form input.
get
Adds the account form input.
put
ChannelConfiguration
Gets all configurations for a channel.
get
Gets a configuration for a channel.
get
Enables/disables a channel configuration.
put
Adds a channels' email configuration element.
post
Updates a channels' email configuration element.
put
Deletes a channels' email configuration element.
delete
Add a channels' web hook configuration element.
post
Updates a channels' webhook configuration element.
put
Deletes a channels' web hook configuration element.
delete
Adds an event webhook configuration element.
post
Updates an event webhook configuration element.
put
Deletes an event webhook configuration element.
delete
Updates a channels' messaging log configuration.
post
Updates a channels' customer contact configuration.
post
Channels
Verifies the read capabilities.
get
Get a channel request overview.
get
Get all conversational profiles.
get
Gets the channels.
get
Gets the channel.
get
Get a Channel's UPDATE events.
get
Gets the channel requests.
get
Adds the channel request.
post
Gets the channel request.
get
Gets all channel types.
get
Gets a channel type.
get
Gets channel type categories.
get
Gets a channel type category.
get
Gets the channel request form.
get
Get a channel's custom request form.
get
Get a channel's custom request form input.
get
Add input to the channel's custom request form.
put
Handles the demo account channel request.
post
Gets the monthly ott metrics.
get
Facebook
Get Facebook connections.
get
Update (a) Facebook connection(s).
put
Get a Facebook connection.
get
Get a Facebook account.
get
Adds a Facebook account.
post
Get a Facebook account's form input.
get
Add input to a Facebook account's form.
put
Get Facebook onboarding configuration.
get
Instagram
Get Instagram connections.
get
Update (a) Instagram connection(s).
put
Get a Instagram connection.
get
Get a Instagram account.
get
Adds a Instagram account.
post
Get a Instagram account's form input.
get
Adds the instagram account form input.
put
Get Instagram onboarding configuration.
get
Keywords
Get all claimed keywords (paginated).
get
Claim a keyword.
post
Get a keyword claim by id.
get
Cancel a keyword claim.
delete
Line
Gets the line notify services.
get
Adds the line notify service.
post
Gets the line notify service.
get
Updates the line notify service.
put
Deletes the line notify service.
delete
Get a Line account.
get
Adds a Line account.
post
Get a Line account's form input.
get
Adds the Line account form input.
put
MobilePush
Gets the mobile push android application.
get
Updates the mobile push android application.
put
Deletes the mobile push android application.
delete
Gets the mobile push applications.
get
Adds the mobile push application.
post
Gets the mobile push application.
get
Updates the mobile push application.
put
Deletes the mobile push application.
delete
Gets the mobile push ios application.
get
Updates the mobile push ios application.
put
Deletes the mobile push ios application.
delete
Gets the mobile push ios application CSR.
get
Posts the mobile push ios application cert.
post
ø Gets the mobile push account.
get
Adds the mobile push account.
post
Gets the mobile push account form input.
get
Adds the mobile push account form input.
put
Organizations
Get an organization.
get
Get an organization's accounts.
get
Create an organization account.
post
PhoneNumbers
Get all available phone numbers (paginated).
get
Get a phone number by id.
get
Cancel a dedicated phone number.
delete
Get all available number types (paginated).
get
Get all dedicated phone number requests (paginated).
get
Request a dedicated phone number.
post
Gets a phone number request by id.
get
RichContentServices
Gets the profiles.
get
Adds the profile.
post
Gets the profile.
get
Gets the profile form input.
get
Adds the profile form input.
put
Get an RCS account.
get
Add an RCS account.
post
Get an RCS account's form input.
get
Add an RCS account's form input.
put
Status
Gets the status.
get
TenDlc
Get 10DLC brands.
get
Add 10DLC brand.
post
Get a 10DLC brand.
get
Cancel a 10DLC brand.
delete
Get 10DLC brand form input.
get
Add 10DLC brand form input.
put
Gets the ten DLC brand vetting status.
get
Gets the ten DLC campaigns.
get
Get 10DLC campaigns.
get
Add 10DLC campaign.
post
Get a 10DLC campaign.
get
Cancel a 10DLC campaign.
delete
Get 10DLC campaign form input.
get
Add 10DLC campaign form input.
put
Search for a 10DLC campaign.
get
Trials
Get a trial status.
get
Get Messaging trial number whitelist.
get
Adds a Messaging trial whitelisted number.
post
Delete a Messaging trial whitelisted number.
delete
VerifiedSms
Gets the account.
get
Gets the account form input.
get
Adds the account form input.
put
Viber
Gets the account.
get
Adds the viber account.
post
Gets the account form input.
get
Adds the account form input.
put
WhatsApp
Gets a WhatsApp business account.
get
Adds the business account.
post
Gets the business account form input.
get
Adds WhatsApp business account form input.
put
Gets the WhatsApp supported languages.
get
Gets all known WhatsApp profiles.
get
Adds a WhatsApp profile.
post
Gets a WhatsApp profile.
get
Deletes a WhatsApp profile.
delete
Gets a WhatsApp profile's form input.
get
Adds WhatsApp profile form input.
put
Updates a WhatsApp profile.
put
Triggers a profile phone number one-time-password.
get
Validates a profile phone number.
post
Finalize an imported via embedded sign up and ownership-verified profile.
post
Get a profile's conversational components.
get
Update a profile's conversational components.
put
Gets all known WhatsApp sandbox profiles.
get
Adds a WhatsApp sandbox profile.
post
Gets a WhatsApp sandbox profile.
get
Deletes a WhatsApp sandbox profile.
delete
Gets the expire date for sandbox profiles in a channel group.
get
Gets supported WhatsApp template categories.
get
Gets all WhatsApp templates.
get
Adds a WhatsApp template.
post
Gets a WhatsApp template.
get
Updates a WhatsApp template.
put
Deletes a template.
delete
Gets a template language.
get
Updates the template header settings.
put
Updates the template interactive settings.
put
Updates the template language interactive settings.
put
Updates the template language carousel settings.
put
Updates the template language time to live settings.
put
Requests validation for a template.
post
Adds a replacement field to a template.
post
Updates a template replacement field.
put
Removes a replacement field from a template.
delete
Gets the enabled languages for a template.
get
Adds an enabled language for a template.
post
Removes an enabled language for a template.
delete
Get a template's Meta analytics.
get
Get a template's supplier status.
get
Get a template language's supplier status.
get
Email Gateway API
Email Service
Send Transactional Emails
post
Send Marketing Emails
post
Unsubscribe Service
Email Unsubscribe
post
Email Unsubscribe
post
https://api.cm.com/email/unsubscribe/v1/
{uniqueKey}
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
