Delete sender ID (POST /)
Deletes the ID of the email address or domain specified from the registered sender IDs.
Request Headers
Refer to "Common API request headers".
Request Parameters
Action
Name of the API to run.
"DeleteIdentity"
Data Type | Cardinality |
---|---|
String | 1..1 |
Version
API version.
"v1.0" (optional)
Data Type | Cardinality |
---|---|
String | 0..1 |
Identity
Sender ID to be deleted (email address or domain).
Up to 255 characters.
Data Type | Cardinality |
---|---|
String | 1..1 |
Request Elements
n/a
HTTP status
Status
Returns the status of the request.
One of the following values will be returned.
- 200:
- Normal completion
- 400:
- Request parameter error
- 401:
- Authentication error
- 403:
- Access denied
- 500:
- Internal error
Data Type | Cardinality |
---|---|
Int | 1..1 |
Response elements (normal completion)
DeleteIdentityResponse
Envelope of the response.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | None | DeleteIdentityResult ResponseMetadata |
DeleteIdentityResult
Envelope of the result.
There is no element.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | DeleteIdentityResponse | None |
ResponseMetadata
Envelope of the metadata.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | DeleteIdentityResponse | RequestId |
RequestId
ID that uniquely identifies the request.
This is required when contacting support staff to troubleshoot an issue.
UUID format (example: 647cd254-e0d1-44a9-af61-1d6d86ea6b77)
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | ResponseMetadata | None |
Example of Request
POST / HTTP/1.1
Date: Fri, 06 Jun 2014 11:00:37 AM GMT
Content-Length: ...
Host: mail.jp-east-1.tps5.fujitsu.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8
X-Auth-Token: MIIFvgY...
Action=DeleteIdentity
&Identity=example.com
Example of Response
HTTP/1.1 200 OK
Date: Fri, 06 Jun 2014 11:00:38 GMT
Content-Length: ...
Content-Type: application/xml
x-fj-request-id: 035e3d62-c956-4fd2-b0ee-482337e909cf
<?xml version="1.0" encoding="UTF-8"?>
<DeleteIdentityResponse>
<DeleteIdentityResult/>
<ResponseMetadata>
<RequestId>035e3d62-c956-4fd2-b0ee-482337e909cf</RequestId>
</ResponseMetadata>
</DeleteIdentityResponse>