The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

Journey Builder API Specification

The following table includes the most commonly used REST resources that make up the Interaction Service of the Journey Builder API.

Logical NameHTTP MethodResource
Get Event DefinitionsGET/eventDefinitions
Get Event DefinitionGET/eventDefinitions/key:{key} or /eventDefinitions/{id}
Create Event DefinitionPOST/eventDefinitions
Update Event Definition PUT/eventDefinitions/key:{key} or /eventDefinitions/{id}
Delete Event DefinitionDELETE/eventDefinitions/key:{key} or /eventDefinitions/{id}
Fire Entry Event POST/events
Get Discovery DocumentGET/rest
Get Journey by IDGET/interactions/{id}
Get Collection of JourneysGET/interactions
Create or Save JourneyPOST/interactions
Update Journey VersionPUT/interactions
Delete Journey by IDDELETE/interactions/{id}
Publish Journey Version AsyncPOST/interactions/publishAsync/{id}?versionNumber={versionNumber}
Get Publish StatusGET/interactions/publishStatus/{statusId}
Stop JourneyPOST/interactions/stop/{id}?versionNumber={versionNumber}
Get Journey Audit LogGET/interactions/{id}/audit/{action} or /interactions/{key}/audit/{action}
Download Journey HistoryPOST/interaction/journeyhistory/download
Get Journey History Download EstimatePOST/interaction/journeyhistory/estimate
Get Journey History Download FreshnessGET/interaction/journeyhistory/freshness

Get Started with Journey Builder