API Guide







Delete Account Alias

This API allows you to delete an account alias by ID. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: DELETE

Endpoint URL:

https://api.250ok.com/api/1.0/account/alias

Sample Output:

{
    "status": "success"
}

Parameters

Parameter Description Acceptable Values Required
id The unique identifier of the account alias. Integer Y

Status Responses

Status Description
success 'status' => 'success' indicates that the update was successful.
failed 'status' => 'failed' indicates that the update failed.

Error Responses

Description Code Cause
NULL 401 Your API key does not have sufficient permission to access this endpoint
This alias does not exist. 404 We couldn't find an account alias with the ID provided
You don't have access to this alias. 403 The account alias is not owned by the account provided in the API key
Error deleting alias. 404 There was an unspecified error when trying to delete this alias