Alpha Communication Settings
Communication Settings API
Get communication settings
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/communications/settings"{
"azureClientId": "string",
"azureClientSecret": "string",
"azureTenantId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"defaultReplyTo": "string",
"defaultSenderName": "string",
"emailSignature": "string",
"emailTrackingEnabled": true,
"id": "string",
"lastInboxSync": "2019-08-24T14:15:22Z",
"linkTrackingEnabled": true,
"outlookDeltaLink": "string",
"outlookEnabled": true,
"outlookMailbox": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update communication settings
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/communications/settings" \ -H "Content-Type: application/json" \ -d '{}'{
"azureClientId": "string",
"azureClientSecret": "string",
"azureTenantId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"defaultReplyTo": "string",
"defaultSenderName": "string",
"emailSignature": "string",
"emailTrackingEnabled": true,
"id": "string",
"lastInboxSync": "2019-08-24T14:15:22Z",
"linkTrackingEnabled": true,
"outlookDeltaLink": "string",
"outlookEnabled": true,
"outlookMailbox": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Manually trigger inbox sync
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/communications/settings/sync-inbox"{
"property1": null,
"property2": null
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Send a test email
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
recipient*string
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/communications/settings/test-email" \ -H "Content-Type: application/json" \ -d '{ "recipient": "string" }'{
"property1": "string",
"property2": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Test Outlook connection via Microsoft Graph
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/communications/settings/test-outlook"{
"property1": "string",
"property2": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}