Link/Unlink API Key
  • 08 Nov 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Link/Unlink API Key

  • Dark
    Light
  • PDF

Link API key to object

Method for linking API key to processes and state diagrams.

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": "link",
      "obj": "conv",
      "obj_id": 783230,
      "obj_to": "user",
      "obj_to_id": 76370,
      "privs": [
        {
          "type": "create",
          "list_obj": [
            "all"
          ]
        }
      ],
      "company_id": "i404856373"
    }
  ]
}
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 link
obj string + An object of request conv
obj_id number / number as string + An ID of object that you want to add API Key An ID of an existing Process or State diagram
obj_to string + A type of object user
obj_to_id number + An ID of API Key
privs array + An array with API Key access rights
privs[].type string + Access rights to create tasks create
privs[].list_obj array + ["all"]
company_id string - An ID of a Company An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj_type": "conv",
            "obj_id": 783230,
            "obj_to_type": "user",
            "obj_to_id": 76370,
            "obj_to_title": "New API v2",
            "action_type": "link"
        }
    ]
}
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_type string An object of request conv
obj_id number An ID of process or state diagram
obj_to_type string user
obj_to_id number An ID of API Key An ID of existing API Key
obj_to_title string An name of API Key
action_type string An action of request link, unlink

What's Next