Create Alias
  • 16 Oct 2020
  • 1 Minute To Read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Create Alias

  • Print
  • Share
  • Dark
    Light

Create new Alias

Method for creating new Alias.

URL

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

Request Body

{
    "ops": [
        {
            "type": "create",
            "obj": "alias",
            "name": {{ALIAS_NAME}},
            "description": {{ALIAS_DESCRIPTION}},
            "short_name": {{ALIAS_SHORT_NAME}},
            "project_id": 0,
            "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 create
obj string + An object of request alias
name string + A name of creating Alias Any valid string
description string - A description of creating Alias Any valid string
short_name string + A short name of creating Alias thats going to be assosiatet with linked object At least three symbols. Allowed letters (Aa-Zz), numbers (0-9), and dashes (-)
project_id number - Currently deprecated feature, please use 0 0
company_id string + An ID of a Company An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "obj_id": 78,
            "proc": "ok",
            "obj": "alias"
        }
    ]
}
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 A request id empty
obj_id number An ID of created Alias
proc string The processing status of a specific operation ok, error
obj string An object of request alias
Was This Article Helpful?