Schedule a marketing campaign

POST /v1/marketing_campaigns/{id}/schedule

Schedule a marketing campaign

cURL

curl --request POST \
  --url https://api.scribe-mail.com/v1/marketing_campaigns/{id}/schedule \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.scribe-mail.com/v1/marketing_campaigns/{id}/schedule"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.scribe-mail.com/v1/marketing_campaigns/{id}/schedule', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scribe-mail.com/v1/marketing_campaigns/{id}/schedule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scribe-mail.com/v1/marketing_campaigns/{id}/schedule"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scribe-mail.com/v1/marketing_campaigns/{id}/schedule")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scribe-mail.com/v1/marketing_campaigns/{id}/schedule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "send_email": true,
    "content": {},
    "smart_fields_conditions": [
      [
        {
          "smart_field_id": "<string>",
          "values": [
            "<string>"
          ]
        }
      ]
    ],
    "signature_template_ids": [
      "<string>"
    ],
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z",
    "time_zone": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>"
  },
  "remediation": {
    "dashboard_url": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>"
  },
  "remediation": {
    "dashboard_url": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Response

200

application/json

Scheduled

data · object · required

Show child attributes