curl --request POST \
--url https://api.pocketflows.com/campaigns/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"steps": [
{
"type": "email",
"custom_step_id": "<string>",
"email_template_id": "<string>"
}
],
"segment": "<string>",
"enrolled_customers": [
"<string>"
],
"excluded_customers": [
"<string>"
],
"email_address": "<string>",
"phone_number": "<string>",
"scheduled_at": "<string>",
"metadata": {},
"attributed_revenue": 123
}'
{
"id": "<string>",
"name": "<string>",
"enrolled_customers": [
"<string>"
],
"segment": "<string>",
"steps": [
{
"type": "email",
"custom_step_id": "<string>",
"email_template_id": "<string>"
}
],
"email_address": "<string>",
"phone_number": "<string>",
"status": "draft",
"scheduled_at": "<string>",
"statistics": {
"total_customers_enrolled": 123,
"total_customers_started": 123,
"total_customers_finished": 123
},
"consumed_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"estimated_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"attributed_revenue": 123
}
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
The ID of the campaign
The updated Campaign
object
The response is of type object
.
curl --request POST \
--url https://api.pocketflows.com/campaigns/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"steps": [
{
"type": "email",
"custom_step_id": "<string>",
"email_template_id": "<string>"
}
],
"segment": "<string>",
"enrolled_customers": [
"<string>"
],
"excluded_customers": [
"<string>"
],
"email_address": "<string>",
"phone_number": "<string>",
"scheduled_at": "<string>",
"metadata": {},
"attributed_revenue": 123
}'
{
"id": "<string>",
"name": "<string>",
"enrolled_customers": [
"<string>"
],
"segment": "<string>",
"steps": [
{
"type": "email",
"custom_step_id": "<string>",
"email_template_id": "<string>"
}
],
"email_address": "<string>",
"phone_number": "<string>",
"status": "draft",
"scheduled_at": "<string>",
"statistics": {
"total_customers_enrolled": 123,
"total_customers_started": 123,
"total_customers_finished": 123
},
"consumed_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"estimated_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"attributed_revenue": 123
}
curl --request POST \
--url https://api.pocketflows.com/campaigns/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"steps": [
{
"type": "email",
"custom_step_id": "<string>",
"email_template_id": "<string>"
}
],
"segment": "<string>",
"enrolled_customers": [
"<string>"
],
"excluded_customers": [
"<string>"
],
"email_address": "<string>",
"phone_number": "<string>",
"scheduled_at": "<string>",
"metadata": {},
"attributed_revenue": 123
}'
{
"id": "<string>",
"name": "<string>",
"enrolled_customers": [
"<string>"
],
"segment": "<string>",
"steps": [
{
"type": "email",
"custom_step_id": "<string>",
"email_template_id": "<string>"
}
],
"email_address": "<string>",
"phone_number": "<string>",
"status": "draft",
"scheduled_at": "<string>",
"statistics": {
"total_customers_enrolled": 123,
"total_customers_started": 123,
"total_customers_finished": 123
},
"consumed_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"estimated_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"attributed_revenue": 123
}
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
The ID of the campaign
The updated Campaign
object
The response is of type object
.
curl --request POST \
--url https://api.pocketflows.com/campaigns/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"steps": [
{
"type": "email",
"custom_step_id": "<string>",
"email_template_id": "<string>"
}
],
"segment": "<string>",
"enrolled_customers": [
"<string>"
],
"excluded_customers": [
"<string>"
],
"email_address": "<string>",
"phone_number": "<string>",
"scheduled_at": "<string>",
"metadata": {},
"attributed_revenue": 123
}'
{
"id": "<string>",
"name": "<string>",
"enrolled_customers": [
"<string>"
],
"segment": "<string>",
"steps": [
{
"type": "email",
"custom_step_id": "<string>",
"email_template_id": "<string>"
}
],
"email_address": "<string>",
"phone_number": "<string>",
"status": "draft",
"scheduled_at": "<string>",
"statistics": {
"total_customers_enrolled": 123,
"total_customers_started": 123,
"total_customers_finished": 123
},
"consumed_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"estimated_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"attributed_revenue": 123
}