| PUT | /api/services/{ServiceGuid}/users/group | Update the group to which a service user belongs. | A specific group guid can be specified, or a group type i.e. Guest or Professional. If both group guid and type is specified the guid will be assigned to the user if the group type for the guid match the group type specified by the ServiceUserGroupType property. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | path | Guid | Yes | |
| ServiceUserGuid | query | Guid | Yes | |
| ServiceUserGroupGuid | query | Guid | No | |
| ServiceUserGroupType | body | string | No | Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /api/services/{ServiceGuid}/users/group HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"serviceGuid": "00000000000000000000000000000000",
"serviceUserGuid": "00000000000000000000000000000000",
"serviceUserGroupGuid": "00000000000000000000000000000000",
"serviceUserGroupType": "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"
}
}
}