Update a Project

API Explorer: /projects/{projectId}

To update a project, use PATCH to change the provided configuration for a given project (you need to know the projectId). The sample code updates a test with an ID of 123456 (the 123456 is contained in the URL) with a new test name New Test Name For API, a new description of This is my description, and a new workspaceId of 234567.

If you do not know the projectId of the project to update, use List Projects to return a list of your created projects.

Update a Project 

curl 'https://a.blazemeter.com/api/v4/projects/123456' \
    -X PATCH \
    -H 'Content-Type: application/json' \
    --user 'api_key_id:api_key_secret' \
    -d '{"name":"New Test Name For API"}'

Update a Project Request Attributes

Attributes

  • namestring

    The project name

  • descriptionstring

    The project description

  • workspaceIdinteger

    The workspaceId you want to associate the project to

Update a ProjectUpdate a Project Sample PATCH Body (JSON) 

{
    "name": "New Test Name For API",
    "description": "This is my description",
    "workspaceId": 234567
}

Update a Project Response Attributes

See The Project Object for the details on the response attributes.

Response200 OK 

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": 123456,
        "name": "New Test Name For API",
        "userId": 123456,
        "description": "This is my description",
        "created": 1488987563,
        "updated": 1488987563,
        "workspaceId": 234567,
        "testsCount": 388
    }
}