Delete Alias in a Stage
  • 08 Nov 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Delete Alias in a Stage

  • Dark
    Light
  • PDF

Delete Alias in a Stage

Method for deleting Aliases in Stages.

postman Download our collection of Postman queries to see more examples of Corezoid API v2

URL

https://api.corezoid.com/api/2/json/{{API_LOGIN}}/{{TIMESTAMP}}/{{SIGNATURE}}

Request

{
    "ops": [
        {
            "type": "delete",
            "obj": "alias",
            "obj_id": {{OBJECT_ID}},
            "company_id": {{COMPANY_ID}}
        }
    ]
}
Parameter Type Required Description Possible value
ops JSON Object + The list of operations to proceed via Corezoid API. A parameter keeping JSON objects with operations * * The number is user-limited by RPS limit
type string + A request type delete
obj string + An object of request alias
obj_id number + ID of the Alias, which will be deleted. You can use the obj_short_name instead ID of an existing Alias
obj_short_name string +* Short name of the Alias, which will be deleted, optional. *You can use it instead of the obj_id Short name of an existing Alias
company_id string - Company ID ID of the existing company. The "null" and "0" values are not allowed

Response

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj": "alias",
            "obj_id": 95
        }
    ]
}
Parameter Type Required Description Possible value
request_proc string The overall processing status of all transactions from the request ok, error
ops array The list of request results
id string Request ID empty
proc string Processing status of a specific operation ok, error
obj string Object of the request alias
obj_id number ID of the deleted Alias