Initiate-Email-Verification-Action:POST
(Difference between revisions)
Revision as of 05:26, 12 June 2014
POST /accounts/{account_number}/contacts/action
Apply an action on contacts email e.g. initiate email verification
Contents |
Request
POST /accounts/{account_number}/contacts/action
Request Parameters
- account_number - string
- The user account that owning the email.
Request Headers
- Authorization - HTTP Authorization header [1]
- The Authentication credentials of the client application.
Request Body
{
"action": "verifyEmail",
"actionData": "{contactinfo_type}"
}
- action - string
- The action that should be performed. Allowed values are:
- verifyEmail - email verification.
- actionData - string
- Data to be send with the action. This must be a contact information type.
- contactinfo_type - There are 4 types of contact information that can be used with the request: regular, billing, administrator or technical.
Response
Expected Response Codes
- 202 Accepted
- Success
- 400 Bad Request
- The supplied action is invalid.
- 401 Unauthorized
- The supplied credentials are invalid.
- 403 Forbidden
- The authorized user does not have permissions to access the resource. The only user(s) who has access to the contacts email must be a sales agent, the account owner, or the account technical admin.
- 404 Not Found
- The contacts email for the provided contact info type does not exist.
- 409 Conflict
- The contacts email is already verified.
Examples
Initiate email verification request
Request
POST /accounts/acct515393/contacts/action
Content-Type:application/json; Charset=UTF-8
Authorization: Basic {Base64 string}
{
"action": "verifyEmail",
"actionData": "regular"
}
Response
202 Accepted
See also
