Create Communication | Virtuous Developer Documentation

curl -X POST https://api.virtuoussoftware.com/api/Communication \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "<string>",
  "campaignId": "<integer>",
  "channelType": "<string>",
  "communicationType": "<string>",
  "communicationStep": "<string>",
  "startDateTime": "<dateTime>",
  "ownerId": "<integer>",
  "givingGoal": "<double>",
  "newGiverGoal": "<integer>",
  "internalCostEstimate": "<double>",
  "vendorCostEstimate": "<double>",
  "networkReach": "<integer>"
}'

{
  "communicationId": "<integer>",
  "name": "<string>",
  "campaignId": "<integer>",
  "campaignName": "<string>",
  "channelType": "<string>",
  "communicationType": "<string>",
  "startDateTimeUtc": "<dateTime>",
  "givingGoal": "<decimal>",
  "projectId": "<integer>",
  "projectCode": "<string>",
  "projectName": "<string>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringOptional

campaignIdstringOptional

channelTypestringOptional

communicationTypestringOptional

communicationStepstringOptional

startDateTimestringOptional

ownerIdstringOptional

givingGoalstringOptional

newGiverGoalstringOptional

internalCostEstimatestringOptional

vendorCostEstimatestringOptional

networkReachstringOptional

Response

communicationIdstringOptional

namestringOptional

campaignIdstringOptional

campaignNamestringOptional

channelTypestringOptional

communicationTypestringOptional

startDateTimeUtcstringOptional

givingGoalstringOptional

projectIdstringOptional

projectCodestringOptional

projectNamestringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

Errors

400

Bad Request Error