Skip to main content

/i/tasks/name

Endpoint​

/i/tasks/name

Overview​

Updates the display name of an existing task.

Authentication​

  • API Key (parameter): api_key=YOUR_API_KEY
  • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
  • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions​

  • Requires write access to feature core for the target app.

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)Dashboard API authentication key.
auth_tokenStringYes (or use api_key)Dashboard auth token.
app_idStringYesApp ID used for write-permission validation.
task_idStringYesTask ID to rename.
nameStringNoNew task display name.

Response​

Success Response​

{
  "result": "Success"
}

Response Fields​

FieldTypeDescription
resultString"Success" after update callback.

Error Responses​

Status Code: 400 Bad Request

{
  "result": "Missing parameter \"task_id\""
}

Behavior/Processing​

Behavior Modes​

ModeTriggerProcessing PathResponse Shape
Rename modetask_id existsUpdates name field on matching task document.Wrapped string { "result": "Success" }
No-match modetask_id does not existUpdate callback still resolves through success path in route handler.Wrapped string { "result": "Success" }

Impact on Other Data​

  • Updates task metadata only.

Audit & System Logs​

  • No direct /systemlogs action is emitted by this endpoint.

Database Collections​

CollectionUsed forData touched by this endpoint
countly.membersAuthentication and permission validationReads member identity and app-level write permissions.
countly.long_tasksTask metadata storageUpdates name field on matching task.

Examples​

Example 1: Rename task​

/i/tasks/name?
  api_key=YOUR_API_KEY&
  app_id=6991c75b024cb89cdc04efd2&
  task_id=17f0f6c3a2c42cbced96d4a01f88f9a7f45bc7a5&
  name=Monthly Revenue Export

Limitations​

  • Endpoint does not validate name content/uniqueness; caller should provide meaningful names.
  • Endpoint returns success even when no task document is matched by task_id.

Last Updated​

2026-02-17