Change object (Name/Description/State)
  • 30 Mar 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Change object (Name/Description/State)

  • Dark
    Light
  • PDF

Change object state || Rename object || Change object description

Method allows you to change object state, it's name and description.

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 Body

{
  "ops": [
    {
      "type": "modify",
      "obj": {{OBJ_TYPE}},
      "obj_id": {{OBJ_ID}},
      "title": {{TITLE}},
      "description": {{DESCTIPTION}},
      "status": {{STATE}},
      "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 folder, conv, dashboard
obj_id number / number as string + An ID of object that you want to modify An ID of an existing Folder, Process, State diagram or Dashboard
title string - A new name of object Any valid string
description string - A new description of object Any valid string
status string - A new status of object active, paused, debug
company_id string - An ID of a Company, where sharing object stored An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj": "conv",
            "obj_id": 786896,
            "new_status": 2,
            "old_status": 1,
            "is_changed": true
        }
    ]
}
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 The processing status of a specific operation ok, error
obj string An object of request folder, conv, dashboard
obj_id number An object ID An ID of an existing Folder, Process, State diagram or Dashboard
new_status number (ONLY FOR Processes and State diagrams) The code* of a new status of object 1, 2, 3, 4
old_status number (ONLY FOR Processes and State diagrams) The code* of the previous status of object 1, 2, 3, 4
is_changed boolean (ONLY FOR Processes and State diagrams) A flag of changing object status true, false
  • Status codes:
Code Status
1 active
2 paused
3 debug
4 blocked (only available for Superadmins)