Customization

Create Stage Diagram

Creates a stage diagram.

POST
/stage-diagrams.create

Authorization

AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Request Body

is_custom_leaf_type?boolean

Whether the leaf type corresponds to a custom object.

is_default?boolean

Whether this is a default stage diagram.

leaf_typestring

The leaf type this stage diagram applies to.

Formattext
namestring

The name of the stage diagram. Stage diagram is used for defining stage transitions.

Formattext
stages

List of stages in the diagram.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.devrev.ai/stage-diagrams.create" \  -H "Content-Type: application/json" \  -d '{    "leaf_type": "string",    "name": "string",    "stages": [      {        "stage_id": "string"      }    ]  }'
{
  "stage_diagram": {
    "created_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "created_date": "2023-01-01T12:00:00.000Z",
    "display_id": "string",
    "id": "string",
    "modified_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "modified_date": "2023-01-01T12:00:00.000Z",
    "is_custom_leaf_type": true,
    "is_default": true,
    "leaf_type": "string",
    "name": "string",
    "stages": [
      {
        "is_deprecated": true,
        "is_start": true,
        "stage": {
          "display_id": "string",
          "id": "string",
          "name": "string"
        },
        "transitions": [
          {
            "target_stage": {
              "display_id": "string",
              "id": "string",
              "name": "string"
            }
          }
        ]
      }
    ]
  }
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}