CCC API v8.4.0.0

<back to all web services

UpdateServiceUser

The following routes are available for this service:
PUT/api/services/{ServiceGuid}/usersUpdate a service user's details.Only fields sent in the request will be updated. If a field is set not available in the request, it will not be updated and will be ignored.
UpdateServiceUser Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidpathGuidYes
ServiceUserGuidqueryGuidNo
EmailAddressqueryStringNo
FirstNamebodystringNo
LastNamebodystringNo
LanguagebodystringNo

Allowable Values

  • en
  • fr
  • de
  • es
  • ja
  • nl
  • zh
EnableCampaignsbodybool?No

Allowable Values

  • true
  • false
EnableESignaturesbodybool?No

Allowable Values

  • true
  • false
DefaultSecurebodyServiceUserDefaultSecureNo

Allowable Values

  • Never
  • BasedOnKeywords
  • Always
BlacklistModebodyServiceUserBlacklistModeNo

Allowable Values

  • Never
  • SecureOnly
  • SecureAndBasic
EnableMfabodybool?No

Allowable Values

  • true
  • false
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.

PUT /api/services/{ServiceGuid}/users HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "serviceGuid": "00000000000000000000000000000000",
  "serviceUserGuid": "00000000000000000000000000000000",
  "emailAddress": "String",
  "firstName": "String",
  "lastName": "String",
  "language": "String",
  "enableCampaigns": false,
  "enableESignatures": false,
  "defaultSecure": "String",
  "blacklistMode": "String",
  "enableMfa": false
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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