Delete stage
  • 14 Aug 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Delete stage

  • Dark
    Light
  • PDF

Delete Stage

Method for moving a Stage to the recycle bin (Trash).

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}
{
    "ops": [
        {
            "type": "delete",
            "obj": "stage",
            "obj_id": {{OBJECT_ID}},
            "project_id": {{PROJECT_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 stage
obj_id number + ID of the Stage, which will be deleted. You can use the obj_short_name instead ID of an existing Stage
obj_short_name string +* Short name of the Stage, which will be deleted, optional. *You can use it instead of the obj_id Short name of an existing Stage
project_id number + ID of the Project, in which the Stage will be deleted. You can use project_short_name instead ID of an existing Project
project_short_name string +* Short name of the Project, in which the Stage will be deleted, optional. *You can use it instead of the project_id Short name of an existing Project
company_id string - An ID of a Company, which contains the Stage An ID of the existing Company

Response Body

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

What's Next