Clear Customer Journey Status

Required scope: journey:write

Clears the customer’s selected status on one journey track, leaving the customer with no status set for that track. Get the trackId from List Journey Config. Clearing a track the customer is not currently on is a no-op and still returns the customer.

Generated Reference

POST /public-api/publicapi.v1.Customer/ClearCustomerJourneyStatus

Clears a customer's status on a journey track.

Request ClearCustomerJourneyStatusRequest

Response ClearCustomerJourneyStatusResponse

ClearCustomerJourneyStatusRequest

Field	Type	Description
customer_id	string	Customer whose journey status is being cleared.
track_id	string	Journey track whose status should be cleared.

ClearCustomerJourneyStatusResponse

Field	Type	Description
customer	Customer	The customer after clearing the track status.

Related Types

Customer

Field	Type	Description
id	string
title	string
custom_fields	map<string, string>	Name-keyed compatibility representation; keys are not internal UUIDs.
reference_number	string
created_at	int64
updated_at	int64

Request

{
  "customerId": "be85f4d1-b680-4964-bf62-9828fdf4ce04",
  "trackId": "4c3c9f2e-6d21-4a0b-9d0f-2b1e7c8a4d10"
}

Response

{
  "customer": {
    "id": "be85f4d1-b680-4964-bf62-9828fdf4ce04",
    "title": "Solar installation lead",
    "referenceNumber": "P-000456"
  }
}