Common operations

Updating Records

Update one or several records by sending only the properties that need to change.

Update records

PATCH/api/v2/{entity}Update one or several records

When updating one record, the response is { data: {updated-object} }. When updating several records, the response is { data: [{updated-object-1}, {updated-object-2}, … {updated-object-N}] }.

Send a JSON object in the request body to update one record, or a JSON array to update several. Include id and only the properties that need to change. Updatable properties are listed in the API Property Reference in your Celoxis account.

To update a time entry whose id is 123456 and change its hours to 2.5 and time code to PM:

bash

Example

curl -g -X PATCH \
  -H 'Content-Type: application/json' \
  -H 'Authorization: bearer YourTokenHere' \
  -d '{
    "id": 123456,
    "hours": "2.5",
    "timeCode": "PM"
  }' \
  'https://app.celoxis.com/psa/api/v2/timeEntries'

Move tasks between projects

POST/api/v2/tasks/moveMove one or several tasks to another project

The response is a JSON object representing the move operation result. Send a JSON object to move tasks, or a JSON array to move several groups of tasks. Only tasks and project should be present in the request.

To move tasks whose ids are 99259, 99260 and 99261 to a project whose id is 12345:

bash

Example

curl -g -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: bearer YourTokenHere' \
  -d '{
    "tasks": [
      99259,
      99260,
      99261
    ],
    "project": 12345
  }' \
  'https://app.celoxis.com/psa/api/v2/tasks/move'

Disable notifications for API-based updates

PATCH/api/v2/tasks?notifications=falseUpdate a task without email or in-app notifications

The response is a JSON object with the updated details of the task. Adding ?notifications=false ensures that no email or in-app notifications are triggered for the update.

Send a JSON object in the request body. Include id and only the properties that need to change.

To update a task whose id is 99266 and set its actualPercentComplete to 64 without sending notifications:

bash

Example

curl -g -X PATCH \
  -H 'Content-Type: application/json' \
  -H 'Authorization: bearer YourTokenHere' \
  -d '{
    "id": 99266,
    "actualPercentComplete": 64
  }' \
  'https://app.celoxis.com/psa/api/v2/tasks?notifications=false'