Update project

client.projects.update(, ?, ?): ProjectUpdateResponse { id, created_at, name, 5 more }

PATCH/api/projects/{id}/

Update project

ParametersExpand Collapse

id: string

formatuuid

body: ProjectUpdateParams { description, is_active, name, 2 more }

description?: string

is_active?: boolean

name?: string

minLength1

maxLength255

settings?: unknown

slug?: string

minLength1

maxLength255

ReturnsExpand Collapse

ProjectUpdateResponse { id, created_at, name, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

maxLength255

slug: string

maxLength255

updated_at: string

formatdate-time

description?: string

is_active?: boolean

settings?: unknown

Update project

import OvermindLab from 'overmind-lab';

const client = new OvermindLab();

const project = await client.projects.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(project.id);

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "slug": "slug",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "is_active": true,
  "settings": {}
}

Returns Examples

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "slug": "slug",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "is_active": true,
  "settings": {}
}