Update an Entity

URL

PUT https://<tenant>.bubbleppm.com/api/v3/entities/<entity_id>
PUT https://<tenant>.bubbleppm.com/api/v3/entities/<entity_external_ref>

External Refs

This endpoint supports External Refs. For more information please refer to the documentation here.

Attributes

Name	Type	Required	Default
`external_ref`	ERef<Entity>	No
`name`	string	No
`archived`	boolean	No	`False`
`published`	boolean	No	`False`
`template`	boolean	No	`False`

Example Request

CODE

{
  "external_ref": "DEF_789",
  "name": "My new name",
}

Example Response

CODE

{
    "id": 1,
    "name": "My new name",
    "type": {
        "id": 1,
        "name": "Type 1"
    },
    "model": {
        "id": 1,
        "name": "Model 1",
        "icon": "circle",
        "color": "#19428A"
    },
    "init_start_date": "2023-03-20",
    "created_at": "2022-03-17T09:45:20.042185Z",
    "updated_at": "2023-04-11T12:18:31.418997Z",
    "archived": false,
    "published": true,
    "template": false,
    "health": {
        "id": 2,
        "name": "On Track",
        "icon": "square",
        "color": "#64C3A5"
    },
    "lifecycle_state": {
        "id": 5,
        "name": "Completed",
        "icon": "checkbox-marked-circle-outline",
        "color": "#58595B"
    },
    "code": "111111111",
    "external_ref": "DEF_789"
}