[HTTP GET] ~/journeys/{journeyId}/activities/{activityId}

Description: Get a specific Activity for a given Journey

Request Information

ODATA Queryable

URI Parameters

NameDescriptionTypeAdditional information
journeyId

the specific Journey Id

 integer

Required
activityId

the specific Activity Id

 integer

Required

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

A Journey Activity

Response Content : CampaignActivity

NameDescriptionTypeAdditional information
Id

The Id of the CampaignActivity

 integer

None.
Name

The name of the CampaignActivity

 string

None.
CampaignId

The Id of the Campaign this activity is attached to

 integer

None.
CreatedDate

When this Activity was created

 date

None.
TargetAtRuntime

Should we run the TargetBuilder at runtime?

 boolean

None.
Target

The target (segmented subsection of the contactlist) of this Activity

 Target

None.

Response Codes:

  • 200 - OK
    • The specified Journey's Activity was retrieved and returned successfully.
  • 401 - Unauthorized
    • Request has been denied as it lacks valid Authentication credentials.
  • 403 - Forbidden
    • The user does not have the relevant permissions to perform this action.
  • 404 - NotFound
    • The specified Journey or Activity was not found.
  • 500 - InternalServerError
    • An error occurred while processing this request.

Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Name": "sample string 2",
  "CampaignId": 3,
  "CreatedDate": "2024-12-27T18:42:31.3847186+00:00",
  "TargetAtRuntime": true,
  "Target": {
    "Id": 1,
    "Name": "sample string 2",
    "Notes": "sample string 3",
    "ContactListId": 4,
    "ContactsCount": 5,
    "ContactsCountEmail": 6,
    "ContactsCountSms": 7,
    "ContactsCountEmailWithDuplicates": 8,
    "ContactsCountSmsWithDuplicates": 9
  }
}

application/csp-report

Sample: 
{"Id":1,"Name":"sample string 2","CampaignId":3,"CreatedDate":"2024-12-27T18:42:31.3847186+00:00","TargetAtRuntime":true,"Target":{"Id":1,"Name":"sample string 2","Notes":"sample string 3","ContactListId":4,"ContactsCount":5,"ContactsCountEmail":6,"ContactsCountSms":7,"ContactsCountEmailWithDuplicates":8,"ContactsCountSmsWithDuplicates":9}}

application/xml, text/xml

Sample: 
<CampaignActivity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO">
  <CampaignId>3</CampaignId>
  <CreatedDate>2024-12-27T18:42:31.3847186+00:00</CreatedDate>
  <Id>1</Id>
  <Name>sample string 2</Name>
  <Target>
    <ContactListId>4</ContactListId>
    <ContactsCount>5</ContactsCount>
    <ContactsCountEmail>6</ContactsCountEmail>
    <ContactsCountEmailWithDuplicates>8</ContactsCountEmailWithDuplicates>
    <ContactsCountSms>7</ContactsCountSms>
    <ContactsCountSmsWithDuplicates>9</ContactsCountSmsWithDuplicates>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Notes>sample string 3</Notes>
  </Target>
  <TargetAtRuntime>true</TargetAtRuntime>
</CampaignActivity>