Executes a Communication operation

post

https://yourorgsite.com/api/Communication/_execute

Executes an operation of Communication

With the Communication service, you can perform the following operations on the execute endpoint:

AdvancedEmailEventRequest
CommunicationDataSourceConnectorRequest
CommunicationPreferencesTokenRequest
CommunicationRequest
AdvancedEmailSendRequest
ContactUsRequest

AdvancedEmailEventRequest

BODY PARAMS:

{
  "$type": "Asi.Soa.Communications.DataContracts.AdvancedEmailEventRequest, Asi.Contracts",
  "EntityTypeName": "Communication",
  "OperationName": "AdvancedEmailEvent",
  "AdvancedEmailEventJson": "string value",
  "RequestCulture": "string value"
}

CommunicationDataSourceConnectorRequest

BODY PARAMS:

{
  "$type": "Asi.Soa.Communications.DataContracts.CommunicationDataSourceConnectorRequest, Asi.Contracts",
  "EntityTypeName": "Communication",
  "OperationName": "CommunicationsPreferencesToken",
  "ConnectorAction": {
    "$type": "Asi.Soa.Communications.DataContracts.CommunicationDataSourceConnectorAction, Asi.Contracts"
  },
  "Primary": {
    "$type": "Asi.Soa.Communications.DataContracts.CommunicationDataSourceData, Asi.Contracts"
  },
  "Secondary": {
    "$type": "Asi.Soa.Communications.DataContracts.CommunicationDataSourceData, Asi.Contracts"
  },
  "DataSources": {
    "$type": "Asi.Soa.Communications.DataContracts.CommunicationDataSourceDataCollection, Asi.Contracts"
  },
  "RequestCulture": "string value"
}

CommunicationPreferencesTokenRequest

BODY PARAMS:

{
  "$type": "Asi.Soa.Communications.DataContracts.CommunicationPreferencesTokenRequest, Asi.Contracts",
  "EntityTypeName": "Communication",
  "OperationName": "CommunicationsPreferencesToken",
  "TokenAction": {
    "$type": "Asi.Soa.Communications.DataContracts.CommunicationPreferencesTokenAction, Asi.Contracts"
  },
  "Token": "string value",
  "PartyId": "string value",
  "RequestCulture": "string value"
}

CommunicationRequest

BODY PARAMS:

{
  "$type": "Asi.Soa.Communications.DataContracts.CommunicationRequest, Asi.Contracts",
  "EntityTypeName": "Communication",
  "OperationName": "Communicate",
  "Communication": {
    "$type": "Asi.Soa.Core.DataContracts.DocumentSummaryData, Asi.Contracts"
  },
  "Options": {
    "$type": "Asi.Soa.Communications.DataContracts.CommunicationOptionsData, Asi.Contracts"
  },
  "RunInBackground": false,
  "LogDetail": {
    "$type": "Asi.Soa.Communications.DataContracts.TaskLogDetailData, Asi.Contracts"
  },
  "RequestCulture": "string value"
}

AdvancedEmailSendRequest

BODY PARAMS:

{
  "$type": "Asi.Soa.Communications.DataContracts.AdvancedEmailSendRequest, Asi.Contracts",
  "EntityTypeName": "Communication",
  "OperationName": "Communicate",
  "Communication": {
    "$type": "Asi.Soa.Communications.DataContracts.CommunicationData, Asi.Contracts"
  },
  "Options": {
    "$type": "Asi.Soa.Communications.DataContracts.CommunicationOptionsData, Asi.Contracts"
  },
  "RunInBackground": false,
  "UserId": "string value",
  "LogDetail": {
    "$type": "Asi.Soa.Communications.DataContracts.TaskLogDetailData, Asi.Contracts"
  },
  "RequestCulture": "string value"
}

ContactUsRequest

BODY PARAMS:

{
  "$type": "Asi.Soa.Communications.DataContracts.Communication.ContactUsRequest, Asi.Contracts",
  "EntityTypeName": "Communication",
  "OperationName": "ContactUs",
  "ContentId": "string value",
  "ContentItemId": "string value",
  "FromPartyName": "string value",
  "FromPartyEmailAddress": "string value",
  "Subject": "string value",
  "Message": "string value",
  "RequestCulture": "string value"
}

Responses

200

The request was successful.

201

The resource was successfully created.

202

The resource was asynchronously created.

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here!