Skip to main content

Journey Engine - Versions Rename

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/i/journey-engine/versions/rename

Overview

Rename a journey version.

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions

  • Required permission: Update on the journey_engine feature

Request Parameters

Request body JSON:

  • id (required): Version ID
  • name (required): New name

Examples

POST /i/journey-engine/versions/rename
Content-Type: application/json

{
"id": "67164f4a1f1bd90d6354430b",
"name": "v1 (Updated)"
}

Response

Success Response

{
"id": "67164f4a1f1bd90d6354430b",
"name": "v1 (Updated)"
}

Response Fields

FieldTypeDescription
idStringRenamed version ID from the request.
nameStringNew version name from the request.

Error Responses

  • 500: Rename error

Behavior

  • Parses request body fields id and name.
  • Updates journey_versions.name for the requested version ID.
  • Returns the requested ID/name pair after the update call completes.
  • No related endpoints
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.journey_versionsEndpoint data sourceStores endpoint-related records this endpoint reads or modifies.