curl --request GET \
--url https://api.example.com/api/v4/campaigns/{id} \
--header ':cookie: <api-key>' \
--header 'X-Vero-Project-Id: <x-vero-project-id>'{
"id": "campaign_123",
"object": "campaign",
"title": "Product update announcement: New features go live!",
"created_at": "2023-01-01T10:00+00:00",
"updated_at": "2023-01-01T10:00+00:00",
"action": {
"message_ab_test": {
"id": "message_ab_test_123",
"type": "pick_a_winner",
"pick_a_winner": {
"allocation_percentage": 123,
"metric": "clicks",
"calculation_type": "statistically_significant",
"test_period_in_hours": 123,
"winner_id": "<string>",
"is_winner_statistically_significant": true,
"message_variants": [
{
"allocation_percentage": 123,
"message_id": "<string>",
"valid": true
}
],
"winner_variant_index": 123
},
"split": {
"message_variants": [
{
"allocation_percentage": 123,
"message_id": "<string>",
"valid": true
}
]
},
"object": "<string>"
},
"type": "message_ab_test",
"id": "<string>",
"message": {
"id": "message_123",
"object": "message",
"created_at": "2023-01-01T10:00+00:00",
"updated_at": "2023-01-01T10:00+00:00",
"provider": "provider_123",
"campaign": "campaign_123",
"transactional": true,
"contents": {
"object": "list",
"data": [
{
"id": "<string>",
"type": "email",
"email": {
"body": "<string>",
"id": "content_abc",
"object": "email",
"subject": "<string>",
"to": "<string>",
"from": "<string>",
"cc": "<string>",
"bcc": "<string>",
"locale": "fr-FR",
"headers": "<string>",
"preheader_text": "<string>",
"plain_text": "<string>",
"processor": {
"mjml": "<string>",
"type": "mjml"
},
"options": {
"tracking": true
},
"meta": {
"editor_type": "drag-and-drop"
}
},
"sms": {
"id": "contents_123",
"body": "<string>"
}
}
]
}
},
"journey": {
"id": "journey_123",
"object": "journey",
"created_at": "<string>",
"updated_at": "<string>",
"nodes": {
"object": "list",
"data": [
{
"type": "sms",
"title": "<string>",
"message_id": "message_123",
"sms": {
"object": "sms",
"id": "content_123",
"body": "<string>"
},
"id": "node_123",
"valid": true
}
]
},
"edges": {
"object": "list",
"data": [
{
"source": "node_123",
"target": "node_456",
"index": 123
}
]
}
},
"object": "action"
},
"trigger": "trigger_123",
"audience": "audience_123",
"conversion": {
"object": "conversion",
"type": "event",
"id": "conversion_123",
"created_at": "2023-01-01T10:00+00:00",
"updated_at": "2023-01-01T10:00+00:00",
"event": {
"event_name": "<string>"
}
},
"archived": true,
"status": "draft"
}curl --request GET \
--url https://api.example.com/api/v4/campaigns/{id} \
--header ':cookie: <api-key>' \
--header 'X-Vero-Project-Id: <x-vero-project-id>'{
"id": "campaign_123",
"object": "campaign",
"title": "Product update announcement: New features go live!",
"created_at": "2023-01-01T10:00+00:00",
"updated_at": "2023-01-01T10:00+00:00",
"action": {
"message_ab_test": {
"id": "message_ab_test_123",
"type": "pick_a_winner",
"pick_a_winner": {
"allocation_percentage": 123,
"metric": "clicks",
"calculation_type": "statistically_significant",
"test_period_in_hours": 123,
"winner_id": "<string>",
"is_winner_statistically_significant": true,
"message_variants": [
{
"allocation_percentage": 123,
"message_id": "<string>",
"valid": true
}
],
"winner_variant_index": 123
},
"split": {
"message_variants": [
{
"allocation_percentage": 123,
"message_id": "<string>",
"valid": true
}
]
},
"object": "<string>"
},
"type": "message_ab_test",
"id": "<string>",
"message": {
"id": "message_123",
"object": "message",
"created_at": "2023-01-01T10:00+00:00",
"updated_at": "2023-01-01T10:00+00:00",
"provider": "provider_123",
"campaign": "campaign_123",
"transactional": true,
"contents": {
"object": "list",
"data": [
{
"id": "<string>",
"type": "email",
"email": {
"body": "<string>",
"id": "content_abc",
"object": "email",
"subject": "<string>",
"to": "<string>",
"from": "<string>",
"cc": "<string>",
"bcc": "<string>",
"locale": "fr-FR",
"headers": "<string>",
"preheader_text": "<string>",
"plain_text": "<string>",
"processor": {
"mjml": "<string>",
"type": "mjml"
},
"options": {
"tracking": true
},
"meta": {
"editor_type": "drag-and-drop"
}
},
"sms": {
"id": "contents_123",
"body": "<string>"
}
}
]
}
},
"journey": {
"id": "journey_123",
"object": "journey",
"created_at": "<string>",
"updated_at": "<string>",
"nodes": {
"object": "list",
"data": [
{
"type": "sms",
"title": "<string>",
"message_id": "message_123",
"sms": {
"object": "sms",
"id": "content_123",
"body": "<string>"
},
"id": "node_123",
"valid": true
}
]
},
"edges": {
"object": "list",
"data": [
{
"source": "node_123",
"target": "node_456",
"index": 123
}
]
}
},
"object": "action"
},
"trigger": "trigger_123",
"audience": "audience_123",
"conversion": {
"object": "conversion",
"type": "event",
"id": "conversion_123",
"created_at": "2023-01-01T10:00+00:00",
"updated_at": "2023-01-01T10:00+00:00",
"event": {
"event_name": "<string>"
}
},
"archived": true,
"status": "draft"
}Related resources to expand
OK
"campaign_123"
The resource in the response. Always campaign.
campaign The internal title of the campaign. Not shown to recipients.
"Product update announcement: New features go live!"
ISO 8601 date-time string.
"2023-01-01T10:00+00:00"
ISO 8601 date-time string.
"2023-01-01T10:00+00:00"
Show child attributes
ID of a Trigger.
"trigger_123"
The v1 API ID of a DataImport. Will be updated in future versions.
"audience_123"
If expanded, the full Conversion object.
Show child attributes
draft, cancelled, launched, removed Was this page helpful?