Update a Project

PUT /projects/:id

Update existing project. Any attributes not provided will be left unchanged. Any provided attributes value will replace previous ones.

For now, only basic information and free sections of a project can be updated. Support for editing other sections of project may be added in the future.

Attributes

title string
Title of the project, must be unique, limited to 60 characters.
description string
Description of the project in plain text, limited to 100 characters.
backgroundImage string

URL of the project image cover. Image file must be publicly accessible and use the https protocol.

backgroundVideo string

URL of the project video cover. Video must be hoster on YouTube, be publicly accessible and use the https protocol.

logo string

URL of the project logo. Image file must be publicly accessible and use the https protocol.

links array of string

List of links related to the project. Each of them must use the https protocol.

socialLinks object

List of social networks links related to the project. Each of them must use the https protocol.

socialLinks attributes
socialLinks.facebook string
Facebook link related to the project.
socialLinks.linkedin string
LinkedIn link related to the project.
socialLinks.twitter string
Twitter link related to the project.
socialLinks.youtube string
YouTube link related to the project.
freeSections array of object

Sections of the project that members can format as they wish using richt text editor.

Those sections can be used to add generated content based on other project data or external data related to the project.

freeSection attributes
freeSection.id string
Unique identifier of the section. If left empty, it will create a new section.
freeSection.content string
Content of the section, can contain HTML to format the content.

Sample request body 

{
  "title": "My Super Project",
  "description": "A creative solution to a really time consuming problem.",
  "backgroundImage": "https://domain.com/image-background.jpg",
  "backgroundVideo": "https://youtube.com/watch?v=XXXXXXXXXXX",
  "logo": "https://domain.com/image-logo.jpg",
  "links": [
    "https://domain.com",
    "https://test.com"
  ],
  "socialLinks": {
    "facebook": "https://facebook.com/...",
    "linkedin": "https://linkedin.com/...",
    "twitter": "https://twitter.com/...",
    "youtube": "https://youtube.com/..."
  },
  "freeSections": [
    {
      "id": "6627cb4d6f1f3e2d6cf414bb",
      "content": "<p>Lorem ipsum <strong>dolor</strong> sit amet…</p>"
    }
  ]
}

Returns

If all provided data are valid and the project is updated successfully, the response will return the following attributes. Otherwise, it will return an error.

code string
message string
id string
Unique identifier of the updated project.
participants array of object

List of users added to the project with reduced attributes.

participant attributes
participant.id string
Unique identifier of the participant.
participant.email string
Email address of the participant.
participant.password string

Passwords are automatically generated following the platform password settings for new participants and are to be sent to the concerned users. We highly recommend asking the participant to change their password when they first connect to the platform.

This attribute is never sent for existing participants. User passwords are stored securely as described in our Password policy

Warning

The password should not be stored and is only returned so you can send it to the participant.

Sample response 

{
  "code": "ok",
  "message": "Project updated successfully",
  "id": "6627cb4d6f1f3e2d6cf414bb"
}