CCC API v8.4.0.0

<back to all web services

ChangeServiceUserPassword

The following routes are available for this service:
PUT/api/services/{ServiceGuid}/users/passwordChange the password of a service userChange the password of a service user.
ChangeServiceUserPassword Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidpathGuidYes
ServiceUserGuidqueryGuidNoOnly required if EmailAddress is not supplied.
EmailAddressqueryStringNoOnly required if ServiceUserGuid is not supplied.
OldPasswordbodyStringYesOld password for the service user.
NewPasswordbodyStringYesNew password for the service user.
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/password HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "serviceGuid": "00000000000000000000000000000000",
  "serviceUserGuid": "00000000000000000000000000000000",
  "emailAddress": "String",
  "oldPassword": "String",
  "newPassword": "String"
}
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"
    }
  }
}