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

Modify Alias in a Stage

  • Dark
    Light
  • PDF

Modify Alias

Method for changing name, short name and description of an Alias in a Stage.

URL

postman Download our collection of Postman queries to see more examples of Corezoid API v2.
https://api.corezoid.com/api/2/json/{{API_LOGIN}}/{{TIMESTAMP}}/{{SIGNATURE}}

Request Body

{
    "ops": [
        {
            "type": "modify",
            "obj": "alias",
            "obj_id": {{ALIAS_ID}},
            "title": {{ALIAS_NAME}},
            "description": {{ALIAS_DESCRIPTION}},
            "short_name": {{ALIAS_SHORT_NAME}},
            "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 modify
obj string + An object of request alias
obj_id number + ID of the Alias, which will be modified. 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 modified, optional. *You can use it instead of the obj_id Short name of an existing Alias
title string + Alias new name Any valid string
description string - Alias new description Any valid string
short_name string + Alias new short name At least three symbols. Allowed letters (Aa-Zz), numbers (0-9), and dashes (-)
company_id string - Company ID An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj": "alias",
            "obj_id": 73
        }
    ]
}
Parameter Type 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 An object of request alias
obj_id number Modified Alias ID