PEC-Developer/Current/WebAPIs/Secure email - Revision history

WikiSysop: Created page with "{{ArticleUnstructured |Standalone=No |DisplayName=Secure Email API }} == Base path: /nexus/v3 ==

2023-11-30T16:01:42Z

Created page with "{{ArticleUnstructured |Standalone=No |DisplayName=Secure Email API }} == Base path: /nexus/v3 ==  <div class="web-api-get mw-collapsible mw-collapsed..."

New page
{{ArticleUnstructured
|Standalone=No
|DisplayName=Secure Email API
}}

== Base path: /nexus/v3 ==


<div class="web-api-get mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-get-text"> GET </div>
| <div class="web-api-urlpath">/securemail</div>
<div class="web-api-summary">Get secure emails</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Get a list of secure emails for the specified email address.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| address
|
| The email address of the consumer.
| query
| string
| true
|-
| status
| all
| Specifies the status of emails to count - unread, read or all (both read and unread).
| query
| string
|
|-
| index
| 0
| The start index the API should use to get emails.
| query
| integer
|
|-
| count
| 10
| The number of secure emails the API returns.
| query
| integer
|
|-
| securebox
| <empty>
| Securebox name. Allows to specify optional securebox name to send email to or read from. securebox provides ability to communicate with the same contact within several different departments independently. (contains only A-Z, a-z, 0-9, and must be from 3 to 16 characters long)
| query
| string
|
|-
| x-api-key
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> listSecureMailResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|-
| style="text-align:right;" | data
| (ArrayOfSecureMail):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|-
| 400
| Invalid request parameters provided.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|-
| 404
| Entity with specified ID not found.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|-
| 500
| Server error occurred.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}

|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/securemail?address=string&status=string&index=0&count=0&securebox=string"
</source>
</div>
</div>


<div class="web-api-post mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-post-text"> POST </div>
| <div class="web-api-urlpath">/securemail</div>
<div class="web-api-summary">Send secure email</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Send a secure email. The email is delivered to Genesys as a web form and routed as a standard email.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| securebox
| <empty>
| Securebox name. Allows to specify optional securebox name to send email to or read from. securebox provides ability to communicate with the same contact within several different departments independently. (contains only A-Z, a-z, 0-9, and must be from 3 to 16 characters long)
| query
| string
|
|-
| xxNAMExx
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|-
| data
|
|
| body
|
|
|-
| colspan=6 |
<div class="web-api-example">
{|
| <source>{object}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> data </div>
|-
| style="text-align:right;" | data
| (, optional):
|-
| style="text-align:right;" | operationId
| (operationId, optional):
|}
|}
</div>
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> createSecureMailResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|-
| style="text-align:right;" | secureMailId
| (string):
The unique ID of the secure email.
bff348eb-dd5f-47d6-bf96-0e75b8ecf7ca
|-
| style="text-align:right;" | selfUri
| (string):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|-
| 400
| Invalid request parameters provided.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
(string):
| Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|-
| 500
| Server error occurred.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
(string):
| Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"
-d '{object}'
"https://api-demo.com/nexus/v3/securemail?securebox=string"
</source>
</div>
</div>


<div class="web-api-get mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-get-text"> GET </div>
| <div class="web-api-urlpath">/securemail/count</div>
<div class="web-api-summary">Get a count of unread, read or all secure emails</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Get a count of unread, read or all secure emails for the specified email address.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| address
|
| The email address of the consumer.
| query
| string
| true
|-
| status
| all
| Specifies the status of emails to count - unread, read or all (both read and unread).
| query
| string
|
|-
| securebox
| <empty>
| Securebox name. Allows to specify optional securebox name to send email to or read from. securebox provides ability to communicate with the same contact within several different departments independently. (contains only A-Z, a-z, 0-9, and must be from 3 to 16 characters long)
| query
| string
|
|-
| x-api-key
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> countSecureMailResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|-
| style="text-align:right;" | data
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|-
| colspan=2 | <div class="web-api-body-obj"> data </div>
|-
| style="text-align:right;" | count
| (integer):
The count of secure emails of requested type for the contact.
20
|}
|}
|-
| 400
| Invalid request parameters provided.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|-
| 404
| Entity with specified ID not found.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|-
| 500
| Server error occurred.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/securemail/count?address=string&status=string&securebox=string"
</source>
</div>
</div>


<div class="web-api-get mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-get-text"> GET </div>
| <div class="web-api-urlpath">/securemail/{secureMailId}</div>
<div class="web-api-summary">Get secure email content</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Get the content of a secure email.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| read
|
| If set to true, the API changes the status to "read" for inbound and outbound emails and stops the inbound interaction from routing.
| query
| boolean
|
|-
| x-api-key
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|-
| secureMailId
|
| The ID of the secure email.
| path
| string
| true
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> retrieveSecureMailResponse </div>
|-
| style="text-align:right;" | referenceId
(referenceId):
|-
| style="text-align:right;" | operationId
(operationId):
|-
| style="text-align:right;" | status
(status):
|-
| style="text-align:right;" | secureMail
():
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|-
| 400
| Invalid request parameters provided.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|-
| 500
| Server error occurred.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/securemail/{secureMailId}?read=true"
</source>
</div>
</div>


<div class="web-api-delete mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-delete-text"> DELETE </div>
| <div class="web-api-urlpath">/securemail/{secureMailId}</div>
<div class="web-api-summary">Mark as read or delete a secure email</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Mark the secure email as read if the <tt>remove</tt> query parameter is either absent or set to 'read'. You can delete the secure email entirely if <tt>remove</tt> is set to 'purge'. To delete the secure email from the list of secure emails but keep it in the contact database, set <tt>remove</tt> to 'delete'.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| remove
| read
| You can either mark a secure email as read, mark a secure email as deleted, or delete an email completely using the following values: * read - Mark the secure email as read. * true - Mark the secure email as read. (deprecated) * \<empty\> - Mark the secure email as read. (deprecated) * delete - Mark the secure email as deleted. The API will not return the email in requests to get the list of secure emails, but will keep it in the contact database. * purge - Delete the secure email from the list of emails and contact database.
| query
| string
|
|-
| x-api-key
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|-
| secureMailId
|
| The ID of the secure email.
| path
| string
| true
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> retrieveSecureMailResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|-
| style="text-align:right;" | secureMail
| ():
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|-
| 404
| Entity with specified ID not found.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/securemail/{secureMailId}?remove=string"
</source>
</div>
</div>


<div class="web-api-get mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-get-text"> GET </div>
| <div class="web-api-urlpath">/securemail/{secureMailId}/userdata</div>
<div class="web-api-summary">Get secure email userdata</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Get the attached userdata of a secure email (some internal keys may be omitted).</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| x-api-key
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|-
| secureMailId
|
| The ID of the secure email.
| path
| string
| true
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> retrieveSecureMailUserdataResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|-
| style="text-align:right;" | data
| (object):
Interaction userdata.
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|-
| 400
| Invalid request parameters provided.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|-
| 500
| Server error occurred.
|-
| colspan=2 |
{|
| <source>
{
"referenceId": {
},
"operationId": {
},
"status": {
"code": "string",
"message": "string",
"detail": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (string):
Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
|-
| style="text-align:right;" | message
| (string):
Status message.
|-
| style="text-align:right;" | detail
| (string):
Additional information.
|-
| colspan=2 | <div class="web-api-body-obj"> genericResponse </div>
|-
| style="text-align:right;" | referenceId
| (referenceId):
|-
| style="text-align:right;" | operationId
| (operationId):
|-
| style="text-align:right;" | status
| (status):
|}
|}
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/securemail/{secureMailId}/userdata?"
</source>
</div>
</div>