JUMP TOAccounts and UtilitiesGet account informationgetGet server timegetEmpty recycle binpostContacts and DataAddress booksCreate address bookpostDelete address bookdeleteUpdate address bookputGet address bookgetGet address booksgetGet private address booksgetGet public address booksgetAdd contact to address bookpostBulk import contacts in address book with merge optionpostGet contacts from address bookgetGet modified contacts in address book since dategetGet unsubscribed contacts from address book since dategetUnsubscribe contact from address bookpostResubscribe contact to address bookpostResubscribe contact to address book with no challengepostDelete contact from address bookdeleteDelete contacts from address bookpostDelete all contacts from address bookpostGet bulk contact deletion progressgetContactsCreate contact with consent and preferencespostBulk import contacts collectionpostBulk import contactspostGet contact import statusgetGet contact import reportgetGet contact import report faultsgetUpdate contact with consent and preferencesputDelete contactdeleteGet contactgetGet contact with consentgetGet contact address booksgetGet all contacts countgetGet contactsgetGet contacts created since dategetGet modified contacts since dategetUnified contactsGet contacts based on your criteriagetGets the total number of contacts in the accountgetImport contact collectionputRetrieve the status of a contacts import requestgetDeletes multiple contactspostRetrieve the status of a delete contacts jobgetRetrieve a contact by an identifiergetCreates a contactpostUpserts a contact using a specific identifierputUpdates a contact using a specific identifierpatchDeletes a contact using a specific identifierdeleteInsight and transactional dataAdd transactional data to contactpostBulk add transactional data to contactspostReplace transactional data by keypostGet transactional data import statusgetGet transactional data import reportgetGet transactional data collection for contact by emailgetGet transactional data by keygetGet account scoped transactional datagetGet transactional data collectionsgetDelete transactional data collection for contact by iddeleteDelete transactional data collection for contact by emaildeleteDelete transactional data by keydeleteEmpty transactional data collectionputContact data fieldsCreate contact data fieldpostDelete contact data fielddeleteGet contact data fieldsgetPreferences and subscriptionsUnsubscribe contactpostBulk suppress contactsputResubscribe contactpostResubscribe contact with no challengepostGet suppressed contacts since dategetGet subscriptions for contactgetGet unsubscribed contacts since dategetCreate preferencepostUpdate preferenceputGet preferencesgetGet modified preferences since dategetDelete preferencedeleteSet preferences for contactputGet preferences for contactgetGet contacts opted into a preference and an address bookgetGet contacts opted into a preferencegetGet contacts with modified preference opt-in since dategetGet contacts with modified preference opt-in in address book since dategetSegmentsGet segmentsgetRefresh segmentpostGet refresh progress for segmentgetScoringGet scoring for contactsgetGet scoring modified since date for contactsgetGet scoring for contactgetGet scoring for contacts in address bookgetInsight DataInsight dataLists all Insight data collectionsgetCreates an Insight data collectionpostGets the JSON schema for an Insight data collectiongetEmpties an Insight data collectiondeleteDeletes an Insight data collectiondeleteRetrieve the status of an asynchronous requestgetBulk importBulk imports Insight dataputRetrieve the status of a Insight data import requestgetAccount collectionsList account Insight data collectionsgetRetrieves records from an accounts Insight data collectiongetRetrieve single record from an account Insight data collectiongetUpsert record into an account Insight data collectionputDelete record from an account Insight data collectiondeleteContacts collectionsList Insight data collections for a contactgetRetrieve data for contact-scoped Insight data collectiongetRetrieve records for a contact from Insight data collectiongetRetrieve Insight data record for a contactgetUpsert record into Insight data collection for a contactputEmpty Insight data collection for a contactdeleteDelete record from Insight data collection for a contactdeleteMarketing and AutomationCampaignsCreate campaignpostCreate split test campaignpostUpdate campaignputCopy campaignpostDelete campaigndeleteSend campaignpostSend time optimised campaignpostGet campaign send statusgetAdd campaign attachmentpostRemove campaign attachmentdeleteGet campaign attachmentsgetGet all campaignsgetGet campaigns sent to address book or segmentgetGet campaigngetGet campaign with detailsgetGet campaign summarygetGet campaign opensgetGet campaign opens for a contactgetGet campaign activity for a contactgetGet campaign activity since dategetGet campaign clicksgetGet campaign clicks and link groupsgetGet campaign clicks since dategetGet campaign clicks and link groups since dategetGet campaign opens since dategetGet campaign activitygetGet campaign address booksgetGet campaign clicks for a contactgetGet campaign contact clicks and link groupsgetGet campaigns with activity since dategetGet campaign page views for a contactgetGet campaign page views since dategetGet campaign replies for a contactgetGet campaign ROI activity for a contactgetGet campaign ROI activity since dategetGet campaign social bookmark viewsgetGet campaign social bookmark views for a contactgetGet campaign hard bouncersgetGet campaign split test resultsgetGet custom from addressesgetGet campaign revenue since dategetGet campaign revenue for contactgetCampaign TemplatesCreate templatepostGet template by idgetGet templatesgetUpdate templateputDocumentsCreate document folderpostGet document foldersgetGet documents in foldergetUpload documentpostImagesCreate image folderpostGet image foldersgetGet image folders by idgetUpload campaign imagepostPages and formsGet formsgetGet form by IDgetGet forms with activity since dategetGet form fieldsgetGet form responsesgetGet form responses with activity since dategetProgramsCreate program enrolmentpostGet programsgetGet program by IDgetGet program enrolment report faultsgetGet program enrolmentgetGet program enrolments by statusgetProduct recommendationsGet all product recommendationsgetSMS campaignsCreate SMS campaignpostCopy SMS campaignpostGet SMS campaigngetGet SMS campaignsgetUpdate SMS campaignputDelete SMS campaigndeleteSend SMS messagepostCommunicationsApp MessagingRegistering your app usersCreating a JWT for an app userAndroidiOSJavascriptCordovaContent APIUpload a filepostRetrieve a filegetDelete a filedeleteEmail2SMSOmnichannel messagingCalling the Omnichannel APIAddressing your messagesChannel selectionCross channel messagingCustom messagesMulti part messagesTemplatesAdditional optionsMessage send responseInbound messages and receiptsOmnichannel channelsSMSPushWhatsAppFacebook MessengerTwitter DMApp MessagingOmnichannel APISend a batch of new messagespostSend a new messagepostRetrieves the current state of a specific message.getDeletes a MessagedeletePatches a MessagepatchPosts an inbound messagepostPosts a status for a messagepostPosts a status for an inboundpostRetrieves message history for a profilegetPhone number validationValidates a single phone numbergetTemplatesCreate a templatepostRetrieves a list of all available templatesgetRetrieves a templategetUpdates a templateputDeletes a templatedeleteTransactional emailSend transactional emailpostSend batch transactional emailpostSend transactional email using a triggered campaignpostSend batch transactional email using a triggered campaignpostGet transactional email statisticsgetTransactional Email via SMTPWebhooksMessage EventsProfile EventsFacebook EventsApp Messaging - Conversation EventsApp Messaging - Message EventsApp Messaging - Session EventsChat - EventsChat - Message EventsChat - Presence EventsWebhooks APICreate a webhook configurationpostRetrieves a webhook configurationgetDeletes a webhook configurationdeleteUpdates a webhook configurationputRetrieves a webhook configurationgetRetrieves a webhook available eventsgetGets a list of available events templates that the caller can use when creating webhookgetAnalytics API/cpaas/analytics/conversationmessagesRetrieves conversation message analyticsget/cpaas/analytics/messagesRetrieves message analyticsget/cpaas/analytics/sessionsRetrieves session analyticsget/cpaas/analytics/sms/trackingRetrieves url tracking analyticsget/cpaas/analytics/sms/verifyRetrieves sms verify analyticsget/cpaas/analytics/sms/inboundRetrieves inbound SMS analyticsget/cpaas/analytics/sms/outboundRetrieves outbound SMS analyticsgetAPI Space Management API/cpaas/apispaces/{id}Retrieves an API SpacegetUpdates an API SpaceputDeletes an API spacedelete/cpaas/apispacesRetrieves all API Spaces accessible by the current usergetCreates a new API Spacepost/cpaas/apispaces/{id}/authRetrieves an API Space's authentication configurationgetUpdates an API Space's authentication configurationput/cpaas/apispaces/{id}/pushRetrieves an API Space's push configurationget/cpaas/apispaces/{id}/retentionRetrieves an API Space's data retention configurationgetUpdates an API Space's data retention configurationput/cpaas/apispaces/{id}/push/apnsUpdates an API Space's APNS push certificate configurationput/cpaas/apispaces/{id}/push/apns/{bundleId}/{environment}Deletes a specific bundle from an API Space's APNS push configurationdelete/cpaas/apispaces/{id}/push/apns/{bundleId}/{environment}/certRetrieves a bundle's APNS certificateget/cpaas/apispaces/{id}/push/apnstokenUpdates an API Space's APNS push token configurationputDeletes the APNS push token configuration from an API Space's APNS push configurationdelete/cpaas/apispaces/{id}/push/apnstoken/keyRetrieves the APNS key file for the API Spaceget/cpaas/apispaces/{id}/push/fcm/{package}Updates an API Space's FCM push configurationputDeletes a specific package from an API Space's FCM push configurationdeleteChat Config API/cpaas/chat/configRetrieves the chat configuration for an apiSpaceget/cpaas/chat/config/teams/{teamId}Retrieves the members of a teamgetRemoves the config for a teamdelete/cpaas/chat/config/teams/{teamId}/appMessagingUpdate the App Messaging config for a teamputRemoves the App Messaging config for a teamdelete/cpaas/chat/config/teams/{teamId}/settingsUpdate general settings for a teamputRemoves the settings for a teamdeleteChat Message API/cpaas/chats/{chatId}/eventsRetrieves a chat's eventsget/cpaas/chats/{chatId}/messagesRetrieves a chat's messages from an point (event) in time and works backwardsgetSends a message to chatpost/cpaas/chats/{chatId}/messages/statusupdatesPosts message updates backpostChat API/cpaas/chats/{chatId}Retrieves a chatgetUpdates a chatputDeletes a chatdelete/cpaas/chats/{chatId}/assignAssigns a chatput/cpaas/chats/{chatId}/closeCloses a chatput/cpaas/chats/{chatId}/channelChanges the channel for an existing chatput/cpaas/chats/{chatId}/formSends a form to a chatpost/cpaas/chatsRetrieves a list of chatsgetCreates a new chatpost/cpaas/chats/{chatId}/typingIndicates that the caller is typing in this chatpostIndicates that the caller has stopped typing in this chatdelete/cpaas/chats/{chatId}/participantsRetrieves the chat participantsgetConversation Message API/cpaas/conversations/{conversationId}/eventsRetrieves a conversation's eventsget/cpaas/conversations/{conversationId}/messagesRetrieves a conversation's messages from an point (event) in time and works backwardsgetSends a message to conversationpost/cpaas/conversations/{conversationId}/messages/statusupdatesPosts message updates backpostConversation API/cpaas/conversations/{conversationId}Retrieves a conversationgetUpdates a conversationputDeletes a conversationdelete/cpaas/conversationsRetrieves a list of conversationsgetCreates a new conversationpost/cpaas/conversations/{conversationId}/typingIndicates that the caller is typing in this conversationpostIndicates that the caller has stopped typing in this conversationdelete/cpaas/conversations/{conversationId}/participantsRetrieves the conversation participantsgetAdds a list of participants to a conversationpostDeletes a list of participants from a conversationdeleteMessage Rules API/cpaas/automation/inboundrulesRetrieves a message rules configuration listgetCreate a message rule configurationpost/cpaas/automation/inboundrules/{messageRulesId}Retrieves single message rule configurationgetUpdate single message rule configurationputDelete single message rule configurationdeleteChat Presence API/cpaas/presenceRetrieves the presence for a list of agent's profileIdsget/cpaas/presence/appmessagingRetrieves the presence for a list of user's profileIdsgetProfile API/cpaas/profiles/exportExports the result of a profile query in a formatted file for downloadpost/cpaas/profiles/bulkDeletes the requested profilesdeleteCreates or updates the supplied profiles with the supplied datapatch/cpaas/profiles/{id}Retrieves a ProfilegetUpdates or undeletes a ProfileputDeletes a ProfiledeletePatches a Profilepatch/cpaas/profiles/{id}/optinSet profile opt in for specified channelsputSet profile opt in for specified channelsdelete/cpaas/profiles/{id}/rels/primary/{linkedId}Creates a relationship where the linked profile is the primary and this profile is a childputDeletes the profile's relationship to a primary profiledelete/cpaas/profiles/{id}/rels/link/{linkedId}Creates a relationship where this profile is the primary and the linked profile is a childputDeletes the primary profile's relationship to a linked Profiledelete/cpaas/profilesQuery profilesgetCreates a new Profilepost/cpaas/profiles/optinGets default profiles opt in/out options for each channel in channel servicegetSet default profiles opt in/out options for each channel in channel serviceputDeprecatedAddress booksBulk import contacts in address bookpostContactsCreate contactpostCreate contact with consentpostUpdate contactputUpdate contact with consentputSMS campaignsSOAP APISOAP - AccountGetCurrentAccountInfoEmptyRecycleBinSOAP - Address booksCreateAddressBookUpdateAddressBookDeleteAddressBookGetAddressBooksGetAddressBookByIdGetAddressBooksForCampaignGetAddressBooksForContactAddContactToAddressBookImportContactsToAddressBookImportContactsToAddressBookWithMergeOptionGetContactsInAddressBookGetModifiedContactsInAddressBookGetContactsScoreInAddressBookGetContactsInAddressBookWithPreferenceGetModifiedPreferencesOptInsByAddressBookUnsubscribeContactFromAddressBookGetUnsubscribedContactsInAddressBookResubscribeContactToAddressBookResubscribeContactToAddressBookWithNoChallengeDeleteContactFromAddressBookDeleteContactsFromAddressBookDeleteAllContactsFromAddressBookSOAP - CampaignsCreateCampaignCreateSplitTestCampaign (beta)CopyCampaignUpdateCampaignSendCampaignSendTimeOptimisedCampaignDeleteCampaignGetCampaignSendProgressAttachDocumentToCampaignDetachDocumentFromCampaignGetCampaignAttachmentsGetCampaignsGetCampaignsForAddressBookGetCampaignByIdGetCampaignSummaryGetCampaignWithDetailsGetCampaignOpensGetCampaignOpensSinceDateGetCampaignActivitiesGetCampaignActivitiesSinceDateGetSentCampaignsWithActivitySinceDateGetCampaignClicksGetCampaignClicksSinceDateGetCampaignClicksAndLinkGroupsGetCampaignClicksAndLinkGroupsSinceDateGetCampaignPageViewsSinceDateGetCampaignContactActivityGetCampaignContactClicksGetCampaignContactClicksAndLinkGroupsGetCampaignContactOpensGetCampaignContactPageViewsGetCampaignContactRepliesGetCampaignContactRoiDetailsGetCampaignRoiDetailsSinceDateGetCampaignContactSocialBookmarkViewsGetCampaignSocialBookmarkViewsGetCampaignHardBouncingContactsGetCampaignSplitTestResults (beta)SOAP - ContactsCreateContactCreateContactWithConsentCreateContactWithConsentAndPreferencesImportContactsUpdateContactUpdateContactWithConsentUpdateContactWithConsentAndPreferencesDeleteContactGetContactByEmailGetContactByIdGetAllAccountContactsCountGetContactsGetModifiedContactsGetNewContactsGetContactImportProgressGetContactImportReportGetContactImportReportFaultsGetSuppressedContactsGetUnsubscribedContactsUnsubscribeContactResubscribeContactResubscribeContactWithNoChallengeGetContactsScoreGetContactsScoreModifiedSinceDateGetContactScoreByEmailGetContactScoreByContactIdGetContactByIdWithConsentGetContactByEmailWithConsentGetContactsWithPreferenceGetModifiedPreferenceOptInsSOAP - Contact data fieldsCreateDataFieldDeleteDataFieldGetDataFieldsSOAP - Custom from addressesGetCustomFromAddressesSOAP - Document foldersCreateDocumentFolderUploadDocumentGetDocumentFoldersGetDocumentsSOAP - Image foldersCreateImageFolderUploadImageGetImageFoldersGetImageFolderByIdSOAP - Pages and formsGetSurveysGetSurveyByIdGetSurveyFieldsGetSurveyResponsesGetSurveyResponsesWithActivitySinceDateGetSurveysWithActivitySinceDateSOAP - PreferencesCreatePreferenceSetPreferencesForContactUpdatePreferenceDeletePreferenceGetPreferencesGetPreferencesForContactGetPreferencesModifiedSinceDateSOAP - Product recommendationsGetProductRecommendationsSOAP - ProgramsCreateEnrolmentGetProgramsGetProgramByIdGetEnrolmentReportGetEnrolmentsByStatusGetEnrolmentByIdSOAP - SegmentsGetSegmentsGetSegmentRefreshProgressRefreshSegmentSOAP - Server timeGetServerTimeSOAP - SMSSendSingleSmsMessageCreateSMSCampaignCopySMSCampaignGetSMSCampaignsGetSMSCampaignUpdateSMSCampaignDeleteSMSCampaignSOAP - TemplatesGetTemplatesCreateTemplateUpdateTemplateGetTemplateByIdSOAP - Transactional emailSendTransactionalEmailSendTransactionalEmailTriggeredCampaignGetTransactionalEmailStatisticsSOAP - Transactional dataAddTransactionalDataImportTransactionalDataReplaceTransactionalDataByKeyDeleteTransactionalDataByContactDeleteTransactionalDataByKeyGetTransactionalDataImportProgressGetTransactionalDataImportReportGetTransactionalDataByContactGetTransactionalDataByKeyGetAccountScopedTransactionalDataOmnichannel channelsThis section covers the channels the Omnichannel API supports.
