Marketing
Common Guides
API Reference
- Templates
- Campaigns
- Content Blocks
Get campaign
import { StackOne } from "@stackone/stackone-client-ts";
const stackOne = new StackOne({
security: {
username: "",
password: "",
},
});
async function run() {
const result = await stackOne.marketing.getCampaign({
id: "<id>",
fields: "id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages",
xAccountId: "<id>",
});
// Handle the result
console.log(result);
}
run();
{
"data": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "<string>",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z",
"description": "<string>",
"schedule_type": {
"value": "immediate",
"source_value": "Immediate"
},
"status": {
"value": "email",
"source_value": "Email"
},
"archived": true,
"draft": true,
"channels": [
{
"value": "sms",
"source_value": "SMS"
}
],
"first_sent_at": "2021-01-01T01:01:01.000Z",
"last_sent_at": "2021-01-01T01:01:01.000Z",
"tags": [
"<string>"
],
"messages": [
{
"id": "message-id-1",
"name": "SMS Message",
"message_type": {
"value": "sms",
"sourceValue": "sms-message"
},
"message_content": {
"body": "This is an example SMS body.",
"from": "1-555-123-4567"
}
},
{
"id": "message-id-2",
"name": "Email Message",
"message_type": {
"value": "email",
"sourceValue": "email-message"
},
"message_content": {
"subject": "Example Email Subject",
"body": "<h1>This is an example</h1>\n <p>email body</p>",
"from": "Jane Smith",
"reply-to": "reply@example.com",
"preheader": "This is the preheader of the email."
}
},
{
"id": "message-id-3",
"name": "iOS Push Message",
"message_type": {
"value": "ios_push",
"sourceValue": "ios-push"
},
"message_content": {
"body": "This is an example push notification body."
}
}
]
},
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Headers
The account identifier
Path Parameters
Query Parameters
Indicates that the raw request result is returned
Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
Response
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The created_at date
"2021-01-01T01:01:01.000Z"
The updated_at date
"2021-01-01T01:01:01.000Z"
The first_sent_at date
"2021-01-01T01:01:01.000Z"
The last_sent_at date
"2021-01-01T01:01:01.000Z"
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Stackone enum identifying the type of message associated with the content.
The unified message type.
email
, sms
, push
, web_push
, ios_push
, android_push
, app_push
, omni_channel
, content_block
, in_app
, unknown
, unmapped_value
"email"
The original value from the provider used to derive the unified message type.
"Email"
[
{
"id": "message-id-1",
"name": "SMS Message",
"message_type": {
"value": "sms",
"sourceValue": "sms-message"
},
"message_content": {
"body": "This is an example SMS body.",
"from": "1-555-123-4567"
}
},
{
"id": "message-id-2",
"name": "Email Message",
"message_type": {
"value": "email",
"sourceValue": "email-message"
},
"message_content": {
"subject": "Example Email Subject",
"body": "<h1>This is an example</h1>\n <p>email body</p>",
"from": "Jane Smith",
"reply-to": "reply@example.com",
"preheader": "This is the preheader of the email."
}
},
{
"id": "message-id-3",
"name": "iOS Push Message",
"message_type": {
"value": "ios_push",
"sourceValue": "ios-push"
},
"message_content": {
"body": "This is an example push notification body."
}
}
]
Was this page helpful?
import { StackOne } from "@stackone/stackone-client-ts";
const stackOne = new StackOne({
security: {
username: "",
password: "",
},
});
async function run() {
const result = await stackOne.marketing.getCampaign({
id: "<id>",
fields: "id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages",
xAccountId: "<id>",
});
// Handle the result
console.log(result);
}
run();
{
"data": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "<string>",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z",
"description": "<string>",
"schedule_type": {
"value": "immediate",
"source_value": "Immediate"
},
"status": {
"value": "email",
"source_value": "Email"
},
"archived": true,
"draft": true,
"channels": [
{
"value": "sms",
"source_value": "SMS"
}
],
"first_sent_at": "2021-01-01T01:01:01.000Z",
"last_sent_at": "2021-01-01T01:01:01.000Z",
"tags": [
"<string>"
],
"messages": [
{
"id": "message-id-1",
"name": "SMS Message",
"message_type": {
"value": "sms",
"sourceValue": "sms-message"
},
"message_content": {
"body": "This is an example SMS body.",
"from": "1-555-123-4567"
}
},
{
"id": "message-id-2",
"name": "Email Message",
"message_type": {
"value": "email",
"sourceValue": "email-message"
},
"message_content": {
"subject": "Example Email Subject",
"body": "<h1>This is an example</h1>\n <p>email body</p>",
"from": "Jane Smith",
"reply-to": "reply@example.com",
"preheader": "This is the preheader of the email."
}
},
{
"id": "message-id-3",
"name": "iOS Push Message",
"message_type": {
"value": "ios_push",
"sourceValue": "ios-push"
},
"message_content": {
"body": "This is an example push notification body."
}
}
]
},
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}