Jump to Content
Guides
API Reference
v1.0.0
v1.1.0
API Reference
v1.0.0
Guides
API Reference
Get a specific mail
JUMP TO
API
Events
/events/v1.0/tenants/{tenantId}/events/{eventTypeId}
post
/events/v1.0/tenants/{tenantId}/events
post
Customer Data Platform - Profiles
Events
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/{profileId}/events
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/{profileId}/events/_summary
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/{profileId}/events/_overview
get
/profile/v1.0/tenants/{tenantId}/events
post
/profile/v1.0/tenants/{tenantId}/events/_count
post
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/events/{eventId}
get
EventTypes
/profile/v1.0/tenants/{tenantId}/eventtypes
get
/profile/v1.0/tenants/{tenantId}/eventtypes
post
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/eventtypes
get
/profile/v1.0/tenants/{tenantId}/eventtypes/{eventTypeId}
get
/profile/v1.0/tenants/{tenantId}/eventtypes/{eventTypeId}
put
/profile/v1.0/tenants/{tenantId}/eventtypes/{eventTypeId}
patch
/profile/v1.0/tenants/{tenantId}/eventtypes/{eventTypeId}
del
Exports
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/csv
post
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/{profileId}/export
get
/profile/v1.0/tenants/{tenantId}/exportevents
get
Profiles
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/_query
post
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/_count
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/_count
post
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/segments/{segmentId}/count
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/segments/{segmentId}/profiles
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/bytoken/{profileToken}
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/bytoken/{profileToken}/details
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/bytoken/{profileToken}/_hard
del
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/byquery/_hard
post
ProfileTypeProperties
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/properties
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/properties
post
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/properties/{propertyId}
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/properties/{propertyId}
put
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/properties/{propertyId}
del
ProfileTypes
/profile/v1.0/tenants/{tenantId}/profiletypes
get
/profile/v1.0/tenants/{tenantId}/profiletypes
post
/profile/v1.0/tenants/{tenantId}/profiletypes/main
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/children
get
/profile/v1.0/tenants/{tenantId}/eventtypes/{eventTypeId}/sessiontype
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}
put
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}
del
Segments
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/segments
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/segments/{segmentId}
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/segments/_count
get
/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/segments/{segmentId}/_rename
put
Workflows
/profile/v1.0/tenants/{tenantId}/workflows/_count
get
/profile/v1.0/tenants/{tenantId}/workflows/_query
post
/profile/v1.0/tenants/{tenantId}/workflows/{id}
get
/profile/v1.0/tenants/{tenantId}/workflows/{id}
put
/profile/v1.0/tenants/{tenantId}/workflows/{id}
del
/profile/v1.0/tenants/{tenantId}/workflows/{id}/_copy
post
/profile/v1.0/tenants/{tenantId}/workflows/{id}/_manual
post
/profile/v1.0/tenants/{tenantId}/workflows/{id}/_enable
put
/profile/v1.0/tenants/{tenantId}/workflows/{id}/_disable
put
/profile/v1.0/tenants/{tenantId}/workflows/{id}/_favorite
put
/profile/v1.0/tenants/{tenantId}/workflows/{id}/_unfavorite
put
Email Validation
EmailAddressValidations
Validate an email address
post
Campaigns
Channels
Gets available channels.
get
Gets available channels.
get
Messages
Adds a campaign.
post
Gets campaigns paged.
get
Deletes multiple campaigns.
del
Search campaigns with specified terms.
get
Gets a campaign by id.
get
Updates a campaign.
put
Deletes a campaign.
del
Cancels a campaign.
post
Gets cost estimation for specified campaign
post
Gets cost estimation for specified campaign
get
Pause sending a campaign.
post
Resume sending a campaign.
post
Sends a test campaign.
post
Sends a test campaign.
post
Senders
Gets senders.
get
Adds a Sender.
post
Updates a Sender.
put
Deletes a Sender.
del
Email Campaigns
Campaign
Get all campaigns for an account
get
Create a campaign
post
Get a specific campaign
get
Update a campaign
put
Delete a campaign
del
Clone a campaign
post
CampaignTags
Get all campaigntags for an account
get
Create a new campaigntag
post
Get a specific campaigntag
get
Update the campaigntag
put
Delete a Campaign
del
Add a campaigntag to a campaign
post
Delete a campaigntag from a campaign
del
FromAddress
Get all fromaddresses for an account
get
Create a new fromaddress
post
Get a specific fromaddress
get
Update the fromaddress except for the emailaddress
put
Delete a fromaddress
del
FromDomains
Get all fromdomains for an account
get
Create a new fromdomain
post
Get a specific fromdomain
get
Delete a fromdomain
del
Verify a from domain
post
Mail
Get a specific mail
get
Send a single mail without a mailing
post
Add a mail to a triggered campaign
post
Mailing
Get all mailings for a campaign
get
Create a campaign mailing
post
Get a specific mailing for a campaign
get
Update a campaign mailing
put
Delete a campaign mailing
del
Template
Get all templates for an account
get
Create a template
post
Get a specific template
get
Update a template
put
Delete a template
del
Get all demo templates
get
Unsubscription
Get all unsubscriptions for an account
get
Create an unsubscription for an account
post
Delete an unsubscription
del
Webhook
Get a webhook
get
Add a webhook
put
Delete a webhook
del
Get a specific mail
get
http://api.cm.com/bulkemail/v1.0/mails/
{mailID}
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!
