PUT
/
v1
/
sms
/
campaigns
/
{campaign}
cURL
curl --request PUT \
  --url https://api.comm.com/api/v1/sms/campaigns/{campaign} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "name": "<string>",
  "meta": {
    "send_type": "manual",
    "segment_ids": [],
    "sms_routing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "filter_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "domain_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "use_dedicated_domains": false,
    "manual_data": {
      "send_amount": 200,
      "send_datetime": "<string>",
      "throttle_batch_size": 0
    },
    "multistep_data": {
      "step_size": 200,
      "step_delay": 5,
      "min_ctr": 123,
      "max_sms_to_send": 1,
      "max_minutes_to_send": 1,
      "send_datetime": "<string>",
      "is_active": true
    },
    "planner_data": {
      "days_of_week": [
        "<string>"
      ],
      "weekly_schedule": {
        "default": {
          "start": "<string>",
          "end": "<string>"
        },
        "Mon": {
          "start": "<string>",
          "end": "<string>"
        },
        "Tue": {
          "start": "<string>",
          "end": "<string>"
        },
        "Wed": {
          "start": "<string>",
          "end": "<string>"
        },
        "Thu": {
          "start": "<string>",
          "end": "<string>"
        },
        "Fri": {
          "start": "<string>",
          "end": "<string>"
        },
        "Sat": {
          "start": "<string>",
          "end": "<string>"
        },
        "Sun": {
          "start": "<string>",
          "end": "<string>"
        }
      },
      "multistep_data": {
        "step_size": 2,
        "step_delay": 2,
        "min_ctr": 123,
        "max_sms_to_send": 1,
        "max_minutes_to_send": 1,
        "send_datetime": "<string>",
        "is_active": true
      },
      "weekly_sms_contact_limit": 5,
      "daily_sms_contact_limit": 1,
      "is_active": true
    },
    "multistep_status": {
      "current_step": 0,
      "total_available_contacts": 0,
      "total_sent": 0,
      "last_sent_timestamp": 123,
      "start_timestamp": 123,
      "initial_brands": [],
      "steps_performance": [],
      "status": "in_progress",
      "status_reason": "No segments selected",
      "last_timezones": [],
      "planner_data": {
        "days_of_week": [
          "<string>"
        ],
        "weekly_schedule": {
          "default": {
            "start": "<string>",
            "end": "<string>"
          },
          "Mon": {
            "start": "<string>",
            "end": "<string>"
          },
          "Tue": {
            "start": "<string>",
            "end": "<string>"
          },
          "Wed": {
            "start": "<string>",
            "end": "<string>"
          },
          "Thu": {
            "start": "<string>",
            "end": "<string>"
          },
          "Fri": {
            "start": "<string>",
            "end": "<string>"
          },
          "Sat": {
            "start": "<string>",
            "end": "<string>"
          },
          "Sun": {
            "start": "<string>",
            "end": "<string>"
          }
        },
        "multistep_data": {
          "step_size": 2,
          "step_delay": 2,
          "min_ctr": 123,
          "max_sms_to_send": 1,
          "max_minutes_to_send": 1,
          "send_datetime": "<string>",
          "is_active": true
        },
        "weekly_sms_contact_limit": 2,
        "daily_sms_contact_limit": 2,
        "is_active": true
      }
    }
  },
  "status": "draft"
}'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "meta": {
      "send_type": "manual",
      "segment_ids": [],
      "sms_routing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "filter_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domain_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "use_dedicated_domains": false,
      "manual_data": {
        "send_amount": 200,
        "send_datetime": "<string>",
        "throttle_batch_size": 0
      },
      "multistep_data": {
        "step_size": 200,
        "step_delay": 5,
        "min_ctr": 123,
        "max_sms_to_send": 1,
        "max_minutes_to_send": 1,
        "send_datetime": "<string>",
        "is_active": true
      },
      "planner_data": {
        "days_of_week": [
          "<string>"
        ],
        "weekly_schedule": {
          "default": {
            "start": "<string>",
            "end": "<string>"
          },
          "Mon": {
            "start": "<string>",
            "end": "<string>"
          },
          "Tue": {
            "start": "<string>",
            "end": "<string>"
          },
          "Wed": {
            "start": "<string>",
            "end": "<string>"
          },
          "Thu": {
            "start": "<string>",
            "end": "<string>"
          },
          "Fri": {
            "start": "<string>",
            "end": "<string>"
          },
          "Sat": {
            "start": "<string>",
            "end": "<string>"
          },
          "Sun": {
            "start": "<string>",
            "end": "<string>"
          }
        },
        "multistep_data": {
          "step_size": 2,
          "step_delay": 2,
          "min_ctr": 123,
          "max_sms_to_send": 1,
          "max_minutes_to_send": 1,
          "send_datetime": "<string>",
          "is_active": true
        },
        "weekly_sms_contact_limit": 5,
        "daily_sms_contact_limit": 1,
        "is_active": true
      },
      "multistep_status": {
        "current_step": 0,
        "total_available_contacts": 0,
        "total_sent": 0,
        "last_sent_timestamp": 123,
        "start_timestamp": 123,
        "initial_brands": [],
        "steps_performance": [],
        "status": "in_progress",
        "status_reason": "No segments selected",
        "last_timezones": [],
        "planner_data": {
          "days_of_week": [
            "<string>"
          ],
          "weekly_schedule": {
            "default": {
              "start": "<string>",
              "end": "<string>"
            },
            "Mon": {
              "start": "<string>",
              "end": "<string>"
            },
            "Tue": {
              "start": "<string>",
              "end": "<string>"
            },
            "Wed": {
              "start": "<string>",
              "end": "<string>"
            },
            "Thu": {
              "start": "<string>",
              "end": "<string>"
            },
            "Fri": {
              "start": "<string>",
              "end": "<string>"
            },
            "Sat": {
              "start": "<string>",
              "end": "<string>"
            },
            "Sun": {
              "start": "<string>",
              "end": "<string>"
            }
          },
          "multistep_data": {
            "step_size": 2,
            "step_delay": 2,
            "min_ctr": 123,
            "max_sms_to_send": 1,
            "max_minutes_to_send": 1,
            "send_datetime": "<string>",
            "is_active": true
          },
          "weekly_sms_contact_limit": 2,
          "daily_sms_contact_limit": 2,
          "is_active": true
        }
      }
    },
    "status": "draft"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign
string
required

Body

application/json

SmsCampaignDataRequest

The body is of type object.

Response

200
application/json

SmsCampaignData

The response is of type object.