| POST | /api/services/{ServiceGuid}/users | Create a new user for a service. | ServiceUserGroupGuid / ServiceUserGroupType - if only ServiceUserGroupGuid is specified then the group identified by that guid is used; if only ServiceUserGroupType is specified then the default group for that type is used; if both ServiceUserGroupGuid and ServiceUserGroupType are specified, the type of the group identified by the ServiceUserGroupGuid has to match the ServiceUserGroupType; if neither ServiceUserGroupGuid nor ServiceUserGroupType are specified, the user will be assigned the services' default package for users. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | path | Guid | Yes | |
| EmailAddress | body | String | Yes | |
| Password | body | String | Yes | |
| FirstName | body | String | Yes | |
| LastName | body | String | Yes | |
| PreRegister | body | Boolean | No | Indicates if the user should be pre-registered on the service. Defaults to false.Allowable Values
|
| SkipRegConfirmation | body | Boolean | No | Indicate if the user should be required to complete the registration page or not when first logging in. Defaults to false.Allowable Values
|
| ServiceUserGroupGuid | body | Guid | No | Identify the group the service user will be added to. |
| ServiceUserGroupType | body | String | No | Identify the group the service user will be added to.Allowable Values
|
| Language | body | String | No | Language code conforms to ISO 639-1. Supported languages must be two-letters and in lowercase.Allowable Values
|
| EnableCampaigns | body | Boolean | No | Allowable Values
|
| EnableESignatures | body | Boolean | No | Allowable Values
|
| DefaultSecure | body | ServiceUserDefaultSecure | No | Allowable Values
|
| BlacklistMode | body | ServiceUserBlacklistMode | No | Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceUserGuid | body | Guid | No |
| 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.
POST /api/services/{ServiceGuid}/users HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"serviceGuid": "00000000000000000000000000000000",
"emailAddress": "String",
"password": "String",
"firstName": "String",
"lastName": "String",
"preRegister": false,
"skipRegConfirmation": false,
"serviceUserGroupGuid": "00000000000000000000000000000000",
"serviceUserGroupType": "String",
"language": "String",
"enableCampaigns": false,
"enableESignatures": false,
"defaultSecure": "String",
"blacklistMode": "String"
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"serviceUserGuid": "00000000000000000000000000000000",
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
}
}