CCC API v8.4.0.0

<back to all web services

CreateArchiveProvider

The following routes are available for this service:
POST/api/collections/{CollectionGuid}/messagearchivingCreate an archive provider.
CreateArchiveProvider Parameters:
NameParameterData TypeRequiredDescription
CollectionGuidpathGuidNo
ServiceGuidbodyGuidYes
NamebodyStringYes
TypebodyStringYes

Allowable Values

  • AllUsers
  • ProOnly
  • DomainOnly
StatusbodyStringYes

Allowable Values

  • Enabled
  • Disabled
DomainsbodyString[]No
MaxAttachmentSizebodyIntegerNo
DestinationbodyStringNo
DeliveryAddressbodyStringNo
DeliveryModebodyStringYes

Allowable Values

  • Smtp
  • ImapJournalling
DeliveryModeOptionsbodyDeliveryModeOptionsYes
MessageTypebodyStringYes

Allowable Values

  • Plain
  • Envelope
AddEnvelopeHeadersbodyBooleanNo

Allowable Values

  • true
  • false
DeliveryModeOptions Parameters:
NameParameterData TypeRequiredDescription
ServerformstringNo
Portformint?No
FolderformstringNo
UserformstringNo
PasswordformstringNo
Sslformbool?No
CreateArchiveProviderResponse Parameters:
NameParameterData TypeRequiredDescription
ArchiveProviderGuidbodyGuidNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/collections/{CollectionGuid}/messagearchiving HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "collectionGuid": "00000000000000000000000000000000",
  "serviceGuid": "00000000000000000000000000000000",
  "name": "String",
  "type": "String",
  "status": "String",
  "domains": [
    "String"
  ],
  "maxAttachmentSize": 0,
  "destination": "String",
  "deliveryAddress": "String",
  "deliveryMode": "String",
  "deliveryModeOptions": {
    "server": "String",
    "port": 0,
    "folder": "String",
    "user": "String",
    "password": "String",
    "ssl": false
  },
  "messageType": "String",
  "addEnvelopeHeaders": false
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "archiveProviderGuid": "00000000000000000000000000000000",
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}