JAjasper
Projects

Update Project by ID

Changed on

Update a Project in your workspace

patch/v1/projects/{id}

Request

  • Base URL
    https://api.jasper.ai
  • URL
    https://api.jasper.ai/v1/projects/{id}
  • Auth
    • API key in header X-API-Key
    • or OAuth 2
      Authorization code: https://api.jasper.ai/oauth2/authorize
      Token URL: https://api.jasper.ai/oauth2/token scopes: user

Path parameters

idstring required
Example:prj_535B1EC15F5F41EAB1B400E9ED4077B6

The Project's unique ID

Request body

userIdstring

The ID of the user updating the project

namestring

The name of the project

accessLevel'PRIVATE' | 'WORKSPACE'

Who can access the project. PRIVATE restricts access to the owning user (plus anyone explicitly shared in); WORKSPACE shares the project with every member of the calling workspace. Omit to leave the current access level unchanged.

metadataobject

An optional set of key-value pairs to attach any data you wish to the project, in a structured format. You can specify up to 10 keys, with key names up to 40 characters long and values up to 500 characters long. Provided string values upsert that key; pass null for a key to remove it; omit this field entirely to leave the existing metadata unchanged.

Example request

{
  "userId": "usr_535B1EC15F5F41EAB1B400E9ED4077B6",
  "name": "Updated Project name",
  "accessLevel": "PRIVATE",
  "settings": {
    "goal": "Launch announcement for Q3 product release",
    "toneId": "ton_535B1EC15F5F41EAB1B400E9ED4077B6",
    "audienceId": "aud_535B1EC15F5F41EAB1B400E9ED4077B6",
    "audienceIds": {
      "primary": "aud_2ee766eaa4ef48e59da1d9602bfecf2d",
      "secondary": [
        "aud_7c1f0b9d2e4a4f6b8d3c5a1e9f0b2c4d"
      ]
    },
    "styleId": "sty_535B1EC15F5F41EAB1B400E9ED4077B6",
    "knowledgeIds": [
      "kno_535B1EC15F5F41EAB1B400E9ED4077B6"
    ]
  },
  "metadata": {
    "externalId": "ext_123",
    "source": null
  }
}

Response

Project updated

requestIdstring required
resourcestring required

Example response

{
  "requestId": "bce766ea-a4ef-48e5-9da1-d9602bfecf2d",
  "resource": "projects",
  "data": [
    {
      "id": "prj_073D2D49094A4AED991A47B614522579",
      "name": "My Canvas",
      "userId": "usr_073D2D49094A4AED991A47B614522579",
      "appUrl": "https://app.jasper.ai/canvas/edit/962e4d4c-ffdc-4c7a-83e3-8f4e715004cf",
      "accessLevel": "PRIVATE",
      "settings": {
        "goal": "Launch announcement for Q3 product release",
        "toneId": "ton_535B1EC15F5F41EAB1B400E9ED4077B6",
        "audienceId": "aud_535B1EC15F5F41EAB1B400E9ED4077B6",
        "audienceIds": {
          "primary": "aud_2ee766eaa4ef48e59da1d9602bfecf2d",
          "secondary": [
            "aud_7c1f0b9d2e4a4f6b8d3c5a1e9f0b2c4d"
          ]
        },
        "styleId": "sty_535B1EC15F5F41EAB1B400E9ED4077B6",
        "knowledgeIds": [
          "kno_535B1EC15F5F41EAB1B400E9ED4077B6"
        ]
      },
      "metadata": {
        "externalId": "ext_123",
        "source": "crm"
      }
    }
  ]
}

Changes

  • 3d5be7408661Revision changes
    • info

      added the new optional request property /////

    • info

      added the optional property /////// to the response with the status