Projects represent work at your Organization - any undertaking that puts Events on your calendar.
For a performing arts organization, we recommend creating a Project for each production. Other useful Projects could reference certain types of meetings or initiatives.
Create a Project
Creates a Project based on the provided fields.
Request Body
orgIdstring · uuid · requiredThe id of the
Organizationthat owns thisProject.namestring · requiredDisplay name of the
Project.
shortNamestringOptional abbreviated name of the
Project.colorstring · hexA color hex code string without the leading
#.detailsstring · htmlOptional details or notes about the
Project. Supports basic HTML tags and formatting.coverPhotoIdstring · uuidThe UUID of an image stored in Cloudflare Images.
keyDatesobject[]Important dates associated with the
Project.
Responses
The newly created Project.
projectobject
Update a Project
Updates the specified Project by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change a Project's id.
This endpoint does not allow you to change the subscribedToEvents property. You can update it via the /projects/{projectId}/subscription endpoint.
path Parameters
projectIdstring · uuid · requiredThe id of the
Project.
Request Body
idstring · uuid · readOnlyThe globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnlyAn ISO 8601-compliant datetime string, formatted
YYYY-MM-DDThh:mm:ssZ.lastUpdatedAtstring · date-time · readOnlyAn ISO 8601-compliant datetime string, formatted
YYYY-MM-DDThh:mm:ssZ.orgIdstring · uuid · readOnlyThe id of the
Organizationthat owns thisProject.namestringDisplay name of the
Project.shortNamestringOptional abbreviated name of the
Project.colorstring · hex...A color hex code string without the leading
#.detailsstring · htmlOptional details or notes about the
Project. Supports basic HTML tags and formatting.coverPhotoIdstring · uuidThe UUID of an image stored in Cloudflare Images.
keyDatesobject[]Important dates associated with the
Project.subscribedToEventsboolean · readOnlyWhether the requesting
Userhas an activeSubscriptionto allEventsassociated with thisProject.
Responses
The updated Project.
projectobject