The following operation is the initial step to change the status of specific email addresses to active or suspend.
Execution permission
Admin, Modify
Request line
GET baseURL/v1/services/MailAddress/actions/changeStatus
Request body
Not applicable.
Response body
The structure of the response body and the object attributes is as follows:Action
{
"name":"...",
"href":"...",
"method":"...",
"type":"...",
"parameters":["...", ...]
}
Action (Type: Action)
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
string |
Name of the action. |
|
href |
string |
URL for the action. |
|
method |
string |
Name of the method. |
|
type |
string |
Data format for the object. |
|
parameters |
anyType[] |
A list of ChangeMailAddressStatusParam objects necessary to execute an operation. For details, see the table below. |
ChangeMailAddressStatusParam
{
"isActive":"...",
"instanceIDs":["...", ...]
}
ChangeMailAddressStatusParam (Type: ChangeMailAddressStatusParam)
|
Attribute |
Type |
Description |
|---|---|---|
|
isActive |
boolean |
Whether or not to enable the email address when it is changed. To enable it, specify "true". To disable it, specify "false". |
|
instanceIDs |
string[] |
ID of the email address whose status is to be changed |
Status codes
|
Status code |
Reason phrase |
Description |
|---|---|---|
|
200 |
OK |
Success. |
|
401 |
Unauthorized |
No login privilege. |
|
412 |
Precondition Failed |
The server is not available. |
|
500 |
Internal Server Error |
Server processing error. |
Example code
[Request Header]
GET /Analytics/v1/services/MailAddress/actions/changeStatus
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json
[Response Header]
HTTP/1.1 200 OK
Date: Wed, 03 Aug 2016 02:02:35 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO a61560c2eac97b0564aec48d2883daf39c0dfdf_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json
[Response Body]
{
"name" : "changeStatus",
"href" : "http://localhost:22015/Analytics/v1/services/MailAddress/actions/changeStatus/invoke",
"method" : "POST",
"type" : "application/json",
"parameters" : [ {
"isActive" : false,
"instanceIDs" : [ ]
} ]
}