API Reference

/api/v1/projects/{projectId}/plans

post
http://localhost:8000/api/v1/projects//plans

This can be used to create a new project plan.

Path Params
string
required
Body Params

Plan creation data, using either an existing document or a newly uploaded file.

string

The unique identifier of the source. This is a user-generated string. You can use this to link the person to a resource in an external system.

string

The name of the plan, including the file extension. If set to null or empty, defaults to the file name.

string

The description of the plan.

string | null
required

ID of the folder containing the plan. If se to null, refers to the default "Unsorted" folder, other must point to an existing folder ID. Folder name takes precedence over folder_id when specified.

string | null
required

Name of the Folder. Will create a folder with this name if it does not exist. Folder name takes precedence over folder_id when specified.

string
required

Data path of the uploaded file. Please check the file uploading documentation for more information: https://capmoapi.readme.io/reference/file-management-api

Headers
string

The HTTP Request-Id request header is an optional and unofficial HTTP header, used to trace individual HTTP requests from the client to the server and back again. It allows the client and server to correlate each HTTP request. If not provided by the client, the server should generate a unique request ID and include it in the response.

Responses

Updated about 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago