Bedrock | API Documentation

Introduction

Every request to Bedrock needs to be authenticated. This is achieved by providing an API-key ('apikey') in the request header. If the API key is of the type SuperKey you also need to provide the email adress ('useremail') of the user to impersonate for the request. If the API-key is a UserKey only the API-key ('apikey') is required. The user to impersonate is already connected to the API-key

Here's an example of the first lines of what a header with Bedrock authentication looks like.

GET example/api/ HTTP/1.1 Accept: */* apikey: d30b6a62-ff15-4e20-8bd0-f33bbd294c66 useremail: someuser@company.com ...

Useremail can be either bizwizardsystem@netoptions.se or the e-mail address of a BizWizard user. Please note that if the user is deleted in BizWizard, Bedrock requests will fail to authenticate.

On error, the response will be a ApiErrorResultModel

ApiKey

Methods for handling API keys

API	Description
POST example/api/apikey/generatesuperkey	Create a new super API key
POST example/api/apikey/generateuserkey	Create a new user API key

AutomatedFlow

Controller for automated flow

API	Description
GET example/api/automatedflow	Get AutomatedFlows.
GET example/api/automatedflow/{automatedFlowId}	Get AutomatedFlow by id.
POST example/api/automatedflow	Create a new AutomatedFlow
GET example/api/automatedflow/{automatedFlowId}/participants	Get all automated flow participant models
GET example/api/automatedflow/{automatedFlowId}/participantproperties	Get all automated flow participant property fields. These properties defines an automated flow participant.
PUT example/api/automatedflow/{automatedFlowId}/participants/{automatedFlowParticipantId}/optout	Opts out an automated flow participant from an automated flow.
POST example/api/automatedflow/{automatedFlowId}/participants	Create automated flow participants.
PUT example/api/automatedflow/participants/{automatedFlowParticipantId}	Update an automated flow participant by id
PATCH example/api/automatedflow/participants/{automatedFlowParticipantId}	Update an automated flow participant partially by id
POST example/api/automatedflow/{automatedFlowId}/participantproperties	Create AutomatedFlowParticipant properties for an AutomatedFlow
POST example/api/automatedflow/{automatedFlowId}/stop	Stops an AutomatedFlow if it is running
DELETE example/api/automatedflow/{automatedFlowId}	Deletes an AutomatedFlow if it is stopped
DELETE example/api/automatedflow/{automatedFlowId}/participants	Delete all automated participants for the specific automated flow
DELETE example/api/automatedflow/{automatedFlowId}/participants/{automatedFlowParticipantId}	Delete automated flow participant by id for the specific automated flow

Content

Methods for handling ContentControllers.

API	Description
GET example/api/mailmessage/{mailMessageId}/htmlcontent	Gets a Content for a given MailMessage.
GET example/api/mailmessage/{mailMessageId}/htmlcontent/links	Gets all links in the content of a mail message
GET example/api/event/{eventId}/registrationpage/htmlcontent	Gets a Content for a given Event.
GET example/api/content/{contentId}/links	Gets all links in the content
PUT example/api/Content/{id}/data	Sets the content data for a given Content.
PUT example/api/content/{id}/thumbnailoptions	Gets a thumbnail for a given Content.
GET example/api/Content/{id}	Gets a Content.
POST example/api/Content	Creates a Content.
PUT example/api/Content/{id}	Updates a Content.
DELETE example/api/Content/{id}	Deletes a Content.

Event

Controller for event

API	Description
GET example/api/event/{id}	Gets a EventModel.
PUT example/api/event/{id}	Updates an existing EventModel
DELETE example/api/event/{id}	Deletes an existing EventModel.
POST example/api/event/{id}/clone	Clones an existing Event
POST example/api/event/{id}/connectexternalobject	Connects an Event to an external object
GET example/api/event/{id}/responses	Gets all responses for a certain Event.
POST example/api/event/{id}/responses	Creates a response for an Event
GET example/api/Event	Gets all EventModels.
POST example/api/Event	Create an EventModel.

Image

Handles ImageModels.

API	Description
GET example/api/Image	Gets all ImageModels.

Layout

Methods for handling LayoutControllers.

API	Description
GET example/api/mailtemplate/{mailTemplateId}/htmlcontent	Gets a html Layout for the given MailTemplate.
GET example/api/mailtemplate/{mailTemplateId}/textcontent	Gets a text Layout for the given MailTemplate.
PUT example/api/layout/{id}/data	Sets the layout data for a given Layout.
GET example/api/Layout/{id}	Gets a Layout.

LinkInfo

Methods for handling LinkInfoControllers.

API	Description
GET example/api/linkinfo/getbycontent/{contentId}	Gets all LinkInfoModels for a desired Content.
GET example/api/linkinfo/getbymailmessagequeue/{mailMessageQueueId}	Gets all LinkInfoModels for a desired MailMessageQueue.

Methods for handling login.

API	Description
POST example/api/login/createeditmailmessageticket	Creates a login ticket which allows a user to edit a specified MailMessage.
POST example/api/login/createeditsurveyticket/{surveyId}	Creates a login ticket which allows a user to edit a specific Survey
POST example/api/login/createeditsurveylandingpageticket/{surveyId}	Creates a login ticket which allows a user to edit the landing page of a specific Survey.
POST example/api/login/CreateEditSurveyAutoReplyNewResponseTicket/{surveyId}	Creates a login ticket which allows a user to edit the response mail of a specific Survey.
POST example/api/login/createediteventticket/{eventId}	Creates a login ticket which allows a user to edit a specific Event.
POST example/api/login/createediteventlandingpageticket/{eventId}	Creates a login ticket which allows a user to edit the landing page of a specific Event.
POST example/api/login/createediteventautoreplynewresponseticket/{eventId}	Creates a login ticket which allows a user to edit the response mail of a specific Event.
POST example/api/login/createselectcreatemailmessageticket	Creates a login ticket which allows a user to edit a specified MailMessage.
POST example/api/login/creategotostartpageticket	Creates a login ticket which allows a user to go to the start page.
POST example/api/login/createviewmailmessagestatisticsticket?mailMessageId={mailMessageId}	Creates a login ticket which allows a user to see an image of the statistics for a MailMessage.
POST example/api/login/createviewmailmessagequeuestatisticsticket?mailMessageQueueId={mailMessageQueueId}	Creates a login ticket which allows a user to see an image of the statistics for a MailMessageQueue.
POST example/api/login/createviewdynamicwebpagetemplateticket/{webpageTemplateId}	Creates a ticket to view a web page template content with dynamic data

MailMessage

Methods for handling MailMessageModels.

API	Description
GET example/api/publication/{publicationId}/mailmessages	Gets the MailMessageModels for a given Publication.
GET example/api/mailmessage/{mailMessageId}/variables	Gets the VariablesInContent for a given MailMessage.
PUT example/api/MailMessage/{mailMessageId}/template/{templateId}	Sets a new MailTemplateModel for a MailMessageModel.
PUT example/api/MailMessage/{mailMessageId}/templatemailmessage/{templateMailMessageId}	Sets a MailMessage as template for another MailMessage.
POST example/api/mailmessage/{mailMessageId}/sendmailmessage	Sends (or schedules) a MailMessage.
GET example/api/mailmessage/{mailMessageId}/previewhtml	Gets preview HTML for a given MailMessage.
POST example/api/mailmessage/{mailMessageId}/mailrecipientlists/included	Adds MailRecipientLists to be included to a MailMessage.
GET example/api/mailmessage/{mailMessageId}/mailrecipientlists/included	Gets the MailRecipientLists that will be included for a MailMessage
POST example/api/mailmessage/{mailMessageId}/mailrecipientlists/excluded	Adds MailRecipientLists to be excluded to a MailMessage.
GET example/api/mailmessage/{mailMessageId}/mailrecipientlists/excluded	Gets the MailRecipientLists that will be excluded for a MailMessage
POST example/api/mailmessage/{mailMessageId}/restore	Restores a deleted MailMessage
PUT example/api/mailmessage/{mailMessageId}/setmessagestatus	Updates the MessageStatus of a MailMessage
POST example/api/mailmessage/{mailMessageId}/addlimerecipients	Gets recipients from a Lime CRM mailing and inserts them to a MailRecipientList. Since parallel imports are not supported it is possible to get a ServiceUnavaliable response with a RetryAfter header. Try to post your request again after the timeout.
POST example/api/mailmessage/{id}/connectexternalobject	Connects a MailMessage to an external object
GET example/api/mailmessage/{mailMessageId}/getviewinbrowserurl	Gets the public "View In Browser" url for a specific MailMessage
GET example/api/MailMessage	Gets all MailMessageModels.
GET example/api/MailMessage/{id}	Gets a MailMessageModel.
POST example/api/MailMessage	Creates a MailMessage.
PUT example/api/MailMessage/{id}	Updates a MailMessageModel.
DELETE example/api/MailMessage/{id}	Deletes a MailMessage.

MailMessageQueue

Methods for handling MailMessageQueueModels.

API	Description
PUT example/api/MailMessageQueue/UpdateScheduledTime/{id}	Updates scheduled time for MailMessageQueue
GET example/api/MailMessageQueue?MailMessageId={MailMessageId}	Gets all MailMessageQueueModels matching a given filter.
DELETE example/api/MailMessageQueue/{id}	Cancels a scheduled MailMessageQueue

MailPublicationOptIn

API	Description
POST example/api/publication/optin/mailrecipients	Adds MailRecipients to a Publication opt-in list.
POST example/api/publication/optin/email	Creates Publication opt-ins for each MailRecipient found or created from the supplied email addresses.
DELETE example/api/publication/{publicationId}/optins	Deletes all MailRecipients in a Publication opt-in list.
POST example/api/publication/optins/delete	Deletes a Publication opt-in.

MailPublicationOptOut

API	Description
GET example/api/publication/{publicationId}/optouts?FromDateTime={FromDateTime}	Gets MailPublicationOptOutModels of a Publication.
DELETE example/api/publication/{publicationId}/optouts	Deletes all MailPublicationOptOutModels of a Publication.
POST example/api/publication/optouts	Creates a publication optout.
DELETE example/api/publication/{publicationId}/optouts?email={email}	Deletes a publication optout.

MailRecipient

Methods for handling MailRecipientModels.

API	Description
GET example/api/mailrecipient/{id}	Gets a MailRecipient.
GET example/api/mailrecipient/{id}?crc={crc}	Gets a MailRecipient.
GET example/api/mailrecipient/GetAllInMailRecipientList/{id}	Gets all MailRecipients in a MailRecipientList.
POST example/api/mailrecipient/CreateFromTabData	Import MailRecipients.
POST example/api/mailrecipient/CreateFromXmlData	Import MailRecipients.
DELETE example/api/mailrecipient/{id}	Deletes a MailRecipient.
POST example/api/mailrecipient/delete	Delete multiple MailRecipients.
GET example/api/mailrecipient/GetAll?Page={Page}&PageSize={PageSize}	Gets all recipients paginated.
GET example/api/MailRecipient?email={email}	Gets MailRecipients based on an email address.

MailRecipientList

Methods for handling MailRecipientLists.

API	Description
PUT example/api/mailrecipientlist/removemailrecipients/{id}	Removes MailRecipients from a MailRecipientList.
PUT example/api/mailrecipientlist/clear/{id}	Clears a MailRecipientList and returns the empty MailRecipientList
GET example/api/MailRecipientList	Gets all MailRecipientLists.
GET example/api/MailRecipientList/{id}	Gets a MailRecipientList.
POST example/api/MailRecipientList	Creates a MailRecipientList.
PUT example/api/MailRecipientList/{id}	Updates a MailRecipientList.
POST example/api/MailRecipientList/{id}	Adds MailRecipients to a MailRecipientList.
DELETE example/api/MailRecipientList/{id}	Deletes a MailRecipientList.

MailRecipientProperty

Methods for handling MailRecipientPropertyControllers.

API	Description
POST example/api/mailrecipientproperty/createtextmailrecipientproperty	Creates a MailRecipientProperty of type Text.
POST example/mailrecipientproperty/createdatemailrecipientproperty	Creates a MailRecipientProperty of type Date.
POST example/mailrecipientproperty/createdatetimemailrecipientproperty	Creates a MailRecipientProperty of type DateTime.
POST example/api/mailrecipientproperty/createnumbermailrecipientproperty	Creates a MailRecipientProperty of type Number.
POST example/api/mailrecipientproperty/createlistmailrecipientproperty	Creates a MailRecipientProperty of type List (recipient can have a single value from multiple possibilities).
POST example/api/mailrecipientproperty/createcheckboxmailrecipientproperty	Creates a MailRecipientProperty of type Checkboxes (recipient can have multiple values from multiple possibilities).
POST example/api/mailrecipientpropertypossibility	Creates a MailRecipientPropertyPossibility.
GET example/api/MailRecipientProperty	Gets all MailRecipientPropertyModels.

MailStatistics

Methods for handling MailStatistics.

API	Description
POST example/api/mailstatistics/GetBouncesByMailMessageQueueId/{mailMessageQueueId}	Gets all bounces of a given MailMessageQueue.
POST example/api/mailstatistics/GetBounces	Gets bounces.
POST example/api/mailstatistics/GetBouncesByBounceId	Gets bounces.
POST example/api/mailstatistics/GetOpeningsByOpeningId	Gets openings.
POST example/api/mailstatistics/GetLinkClicksByLinkClickId	Gets link clicks.
POST example/api/mailstatistics/GetOptOutsByOptOutId	Gets Opt-outs.
POST example/api/mailstatistics/GetNotSentDueToPreviousBounceByPreviousBounceId	Gets the recipients an email message was not sent to due to previous bounce.
POST example/api/mailstatistics/GetNotSentDueToPreviousOptOutByPreviousOptOutId	Gets the recipients an email message was not sent to due to previous optout.

MailTemplate

Methods for handling MailTemplateModels.

API	Description
GET example/api/mailtemplate/name/{name}	Gets a specific MailTemplateModel by name.
PUT example/api/mailtemplate/{id}/thumbnailoptions	Gets a thumbnail for a given MailTemplate.
POST example/api/publication/{publicationId}/template/{templateId}	Adds a MailTemplate to be included in a Publication.
DELETE example/api/publication/{publicationId}/template/{templateId}	Removes a MailTemplate from a Publication.
GET example/api/MailTemplate?PublicationId={PublicationId}	Gets MailTemplates based on provided filter.
GET example/api/MailTemplate/{id}	Gets a specific MailTemlpateModel.
POST example/api/MailTemplate	Creates a MailTemplate.

MailTotalOptOut

Methods for handling MailTotalOptOutControllers.

API	Description
POST example/api/MailTotalOptOut	Creates a MailTotalOptOut (the user will not receive any e-mails).
GET example/api/MailTotalOptOut	Gets all MailTotalOptOuts.
DELETE example/api/MailTotalOptOut?email={email}	Deletes a single MailTotalOptOuts.
DELETE example/api/MailTotalOptOut	Deletes all MailTotalOptOuts.

Publication

Methods for handling PublicationControllers.

API	Description
GET example/api/publication/name/{name}	Gets a publication by its name
POST example/api/publication/{publicationId}/clone	Clones a Publication.
GET example/api/user/{userId}/publications	Gets publications which the user has explit and implicit permissions to use
GET example/api/Publication	Gets all Publications.
GET example/api/Publication/{id}	Gets a Publication.
DELETE example/api/Publication/{id}	Deletes a Publication.
POST example/api/Publication	Creates a Publication.
PUT example/api/Publication/{id}	Updates a Publication

SendingDomain

Handles administration of sending domains

API	Description
PUT example/api/sendingdomain/{id}/setdefault	Set sending domain as default.
GET example/api/SendingDomain	Gets all Sending domains.
GET example/api/SendingDomain/{id}	Gets a Sending domain.
POST example/api/SendingDomain	Creates a Sending domain.
PUT example/api/SendingDomain/{id}	Updates a SendingDomainModel.
DELETE example/api/SendingDomain/{id}	Deletes a Sending domain.
POST example/api/SendingDomain?domain={domain}	Verify a Sending domain - performs domain ownership verification and DKIM/SPF verification. If domain ownership is not done and is invalid DKIM/SPF will not be checked

SmsMessage

Methods for handling SmsMessageModels.

API	Description
GET example/api/publication/{publicationId}/smsmessages	Gets the SmsMessageModels for a given Publication.
GET example/api/smsmessage/{smsMessageId}/variables	Gets the VariablesInContent for a given SmsMessage.
POST example/api/smsmessage/{smsMessageId}/updatetext	Sets new text content for a given SmsMessage.
POST example/api/smsmessage/{smsMessageId}/sendsmsmessage	Sends (or schedules) a SmsMessage.
GET example/api/smsmessage/{smsMessageId}/previewtext	Gets preview text for a given SmsMessage.
POST example/api/smsmessage/{id}/connectexternalobject	Connects a SmsMessage to an ExternalObject
GET example/api/SmsMessage	Gets all SmsMessageModels.
GET example/api/SmsMessage/{id}	Gets a SmsMessageModel.
POST example/api/SmsMessage	Creates a SmsMessage.
PUT example/api/SmsMessage/{id}	Updates a SmsMessage.
DELETE example/api/SmsMessage/{id}	Deletes a SmsMessage.

SmsMessageQueue

Methods for handling SmsMessageQueueModels.

API	Description
PUT example/api/SmsMessageQueue/UpdateScheduledTime/{id}	Updates scheduled time for SmsMessageQueue
GET example/api/SmsMessageQueue?SmsMessageId={SmsMessageId}	Gets all SmsMessageQueueModels matching a given filter.
DELETE example/api/SmsMessageQueue/{id}	Cancels a scheduled SmsMessageQueue

SmsPublicationOptOut

API	Description
GET example/api/publication/{publicationId}/smsoptouts?FromDateTime={FromDateTime}	Gets SmsPublicationOptOutModels of a Publication.
DELETE example/api/publication/{publicationId}/smsoptouts	Deletes all SmsPublicationOptOutModels of a Publication.
POST example/api/publication/smsoptouts	Creates a publication optout.
DELETE example/api/publication/{publicationId}/smsoptouts?mobileNumber={mobileNumber}	Deletes a publication optout.

SmsRecipient

Methods for handling SmsRecipientModels.

API	Description
GET example/api/smsrecipient/GetAllInSmsRecipientList/{id}	Gets all SmsRecipients in a SmsRecipientList.
DELETE example/api/smsrecipient/{id}	Deletes a MailRecipient.
POST example/api/smsrecipient/delete	Delete multiple (max 50)SmsRecipients.
POST example/api/smsrecipient/CreateFromTabData	Import SmsRecipients.
POST example/api/smsrecipient/CreateFromXmlData	Import SmsRecipients.
GET example/api/SmsRecipient?mobileNumber={mobileNumber}	Gets SmsRecipients based on a mobile number.
GET example/api/SmsRecipient/{id}	Gets a SmsRecipient.
GET example/api/SmsRecipient/{id}?crc={crc}	Gets a SmsRecipient.

SmsRecipientList

Methods for handling SmsRecipientLists.

API	Description
PUT example/api/SmsRecipientList/Clear/{id}	Clears a SmsRecipientList and returns the empty list.
PUT example/api/SmsRecipientList/RemoveSmsRecipients/{id}	Removes SmsRecipients from a SmsRecipientList.
GET example/api/SmsRecipientList	Gets all SmsRecipientLists.
GET example/api/SmsRecipientList/{id}	Gets a SmsRecipientList.
POST example/api/SmsRecipientList	Creates a SmsRecipientList.
PUT example/api/SmsRecipientList/{id}	Updates a SmsRecipientList.
POST example/api/SmsRecipientList/{id}	Adds SmsRecipients to a SmsRecipientList.
DELETE example/api/SmsRecipientList/{id}	Deletes a SmsRecipientList.

SmsStatistics

API	Description
POST example/api/smsstatistics/GetDeliveredByDeliveryId	Gets deliveries.
POST example/api/smsstatistics/GetUndeliveredByUndeliveryId	Gets openings.

Survey

Methods for handling SurveyControllers.

API	Description
POST example/api/survey/{id}/clone	Clones an existing Survey
GET example/api/survey/{id}/responses	Gets all responses for a certain Survey.
POST example/api/survey/{id}/responses	Creates a response for a Survey.
GET example/api/Survey	Gets all SurveyModels.
GET example/api/Survey/{id}	Gets a SurveyModel.
POST example/api/Survey	Creates a SurveyModel.
PUT example/api/Survey/{id}	Updates a SurveyModel.
DELETE example/api/Survey/{id}	Deletes a SurveyModel.

Test

Methods to check context user and get the version

API	Description
GET example/api/ping/version	Gets the current version
GET example/api/ping/whoami	Gets the user of the currect context.

Theme

Methods for handling ThemeControllers.

API	Description
GET example/api/Theme	Gets all Themes.

TransactionMail

Methods for handling TransactionMailModels.

API	Description
POST example/api/transactionmail/send	Sends (or schedules) a TransactionMailMessage.
POST example/api/transactionmail/sendbatch	Sends (or schedules) a batch of TransactionMailMessage. Max 100 TransactionMailMessages per batch.
POST example/api/transactionmail/sendtemplate	Sends (or schedules) a TransactionMailMessage based on a MailTemplate.
POST example/api/transactionmail/sendtemplatebatch	Sends (or schedules) a batch of TransactionMailMessage based on a MailTemplate. Max 100 TransactionMailMessages per batch.
POST example/api/transactionmail/sendmailmessage	Sends (or schedules) a TransactionMailMessage based on a MailMessage.
POST example/api/transactionmail/sendmailmessagebatch	Sends (or schedules) a batch of TransactionMailMessage based on a MailMessage. Max 100 TransactionMailMessages per batch.
POST example/api/transactionmail/createcalendarlink	Creates a calendar link

TransactionMailStatistics

API	Description
POST example/api/transactionmailstatistics/GetBouncesByBounceId	Gets bounces.
POST example/api/transactionmailstatistics/GetOpeningsByOpeningId	Gets openings.
POST example/api/transactionmailstatistics/GetLinkClicksByLinkClickId	Gets link clicks.

TransactionSms

API	Description
POST example/api/transactionsms/send	Send a transaction sms with custom content
POST example/api/transactionsms/sendsmsmessage	Sends the content of an existing sms message

User

Methods for handling UserControllers.

API	Description
GET example/api/user/email/{email}	Gets a user by email
GET example/api/publication/{publicationId}/users	Gets the users with permission (explicit and implicit) to use the publication Admin users and users with permission flag to use all publications are also returned
POST example/api/publication/{publicationId}/users	Explicitly sets permissions for users to use the publication
DELETE example/api/publication/{publicationId}/users/{userId}	Removes explicitly set permissions for the user and the publications
GET example/api/User	Gets all Users.
GET example/api/User/{id}	Gets a User.
POST example/api/User	Creates a User.
PUT example/api/User/{id}	Updates a User.
DELETE example/api/User/{id}	Deletes a User.

WebHookSubscription

Methods for handling WebHookSubscriptionModels.

API	Description
GET example/api/WebHookSubscription/{id}	Returns a WebHookSubscriptionModel.
GET example/api/WebHookSubscription	Returns all WebHookSubscriptionModel's.
POST example/api/WebHookSubscription	Creates a WebHookSubscriptionModel.
PUT example/api/WebHookSubscription/{id}	Update a WebHookSubscriptionModel.
DELETE example/api/WebHookSubscription/{id}	Delete a WebHookSubscriptionModel.

WebHookSubscriptionPackage

Methods for handling WebHookSubscriptionPackageModels.

API	Description
GET example/api/WebHookSubscriptionPackage	Returns all WebHookSubscriptionPackageModel's.