The Project Update object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

status string

Default: draft

project string required
sent boolean

Default: false

date string
time string
The Project Update object 
{
  "id": "project-update_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "project": "project_example",
  "sent": false,
  "date": "2024-01-15",
  "time": "time_example"
}
GET /api/projects/project-update/{id}

Retrieve a project update

Retrieves the details of an existing project update. Supply the unique project update ID that was returned from a previous request.

Path parameters

id string required

The identifier of the project update to retrieve.

Returns

Returns the project update object if a valid identifier was provided.

GET /api/projects/project-update/{id} 
curl https://api.overplane.dev/api/projects/project-update/project-update_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "project-update_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "project": "project_example",
  "sent": false,
  "date": "2024-01-15",
  "time": "time_example"
}
GET /api/projects/project-update

List all project updates

Returns a list of project updates. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of project update objects.

GET /api/projects/project-update 
curl https://api.overplane.dev/api/projects/project-update \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "project-update_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "project": "project_example",
      "sent": false,
      "date": "2024-01-15",
      "time": "time_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/projects/project-update

Create a project update

Creates a new project update object.

Body parameters

status string

Default: draft

project string required
sent boolean

Default: false

date string
time string

Returns

Returns the newly created project update object if the call succeeded.

POST /api/projects/project-update 
curl https://api.overplane.dev/api/projects/project-update \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"project":"project_example"}'
Response 
{
  "id": "project-update_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "project": "project_example",
  "sent": false,
  "date": "2024-01-15",
  "time": "time_example"
}
PATCH /api/projects/project-update/{id}

Update a project update

Updates the specified project update by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the project update to update.

Body parameters

status string

Default: draft

project string
sent boolean

Default: false

date string
time string

Returns

Returns the updated project update object.

PATCH /api/projects/project-update/{id} 
curl https://api.overplane.dev/api/projects/project-update/project-update_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","project":"project_example"}'
Response 
{
  "id": "project-update_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "project": "project_example",
  "sent": false,
  "date": "2024-01-15",
  "time": "time_example"
}
DELETE /api/projects/project-update/{id}

Delete a project update

Permanently deletes a project update. This cannot be undone.

Path parameters

id string required

The identifier of the project update to delete.

Returns

Returns a confirmation that the project update has been deleted.

DELETE /api/projects/project-update/{id} 
curl https://api.overplane.dev/api/projects/project-update/project-update_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "project-update_abc123",
  "deleted": true
}
POST /api/projects/project-update/{id}/submit

Submit a project update

Submits a draft project update, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the project update to act on.

Returns

Returns the project update object with updated status.

POST /api/projects/project-update/{id}/submit 
curl https://api.overplane.dev/api/projects/project-update/project-update_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "project-update_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "project": "project_example",
  "sent": false,
  "date": "2024-01-15",
  "time": "time_example"
}
POST /api/projects/project-update/{id}/cancel

Cancel a project update

Cancels a submitted project update, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the project update to act on.

Returns

Returns the project update object with updated status.

POST /api/projects/project-update/{id}/cancel 
curl https://api.overplane.dev/api/projects/project-update/project-update_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "project-update_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "project": "project_example",
  "sent": false,
  "date": "2024-01-15",
  "time": "time_example"
}