Update an automation
curl --request PUT \
--url https://api.example.com/v1/comment-automations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Guide lead magnet",
"mediaIds": [
"<string>"
],
"keywords": [
"guide",
"link"
],
"matchType": "contains",
"dmText": "<string>",
"dmButtonLabel": "<string>",
"dmButtonUrl": "<string>",
"publicReplyText": "<string>",
"oncePerUser": true
}
'import requests
url = "https://api.example.com/v1/comment-automations/{id}"
payload = {
"name": "Guide lead magnet",
"mediaIds": ["<string>"],
"keywords": ["guide", "link"],
"matchType": "contains",
"dmText": "<string>",
"dmButtonLabel": "<string>",
"dmButtonUrl": "<string>",
"publicReplyText": "<string>",
"oncePerUser": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Guide lead magnet',
mediaIds: ['<string>'],
keywords: ['guide', 'link'],
matchType: 'contains',
dmText: '<string>',
dmButtonLabel: '<string>',
dmButtonUrl: '<string>',
publicReplyText: '<string>',
oncePerUser: true
})
};
fetch('https://api.example.com/v1/comment-automations/{id}', 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.example.com/v1/comment-automations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Guide lead magnet',
'mediaIds' => [
'<string>'
],
'keywords' => [
'guide',
'link'
],
'matchType' => 'contains',
'dmText' => '<string>',
'dmButtonLabel' => '<string>',
'dmButtonUrl' => '<string>',
'publicReplyText' => '<string>',
'oncePerUser' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/comment-automations/{id}"
payload := strings.NewReader("{\n \"name\": \"Guide lead magnet\",\n \"mediaIds\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"guide\",\n \"link\"\n ],\n \"matchType\": \"contains\",\n \"dmText\": \"<string>\",\n \"dmButtonLabel\": \"<string>\",\n \"dmButtonUrl\": \"<string>\",\n \"publicReplyText\": \"<string>\",\n \"oncePerUser\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/v1/comment-automations/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Guide lead magnet\",\n \"mediaIds\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"guide\",\n \"link\"\n ],\n \"matchType\": \"contains\",\n \"dmText\": \"<string>\",\n \"dmButtonLabel\": \"<string>\",\n \"dmButtonUrl\": \"<string>\",\n \"publicReplyText\": \"<string>\",\n \"oncePerUser\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/comment-automations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Guide lead magnet\",\n \"mediaIds\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"guide\",\n \"link\"\n ],\n \"matchType\": \"contains\",\n \"dmText\": \"<string>\",\n \"dmButtonLabel\": \"<string>\",\n \"dmButtonUrl\": \"<string>\",\n \"publicReplyText\": \"<string>\",\n \"oncePerUser\": true\n}"
response = http.request(request)
puts response.read_bodyautomations
Update an automation
PUT
/
v1
/
comment-automations
/
{id}
Update an automation
curl --request PUT \
--url https://api.example.com/v1/comment-automations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Guide lead magnet",
"mediaIds": [
"<string>"
],
"keywords": [
"guide",
"link"
],
"matchType": "contains",
"dmText": "<string>",
"dmButtonLabel": "<string>",
"dmButtonUrl": "<string>",
"publicReplyText": "<string>",
"oncePerUser": true
}
'import requests
url = "https://api.example.com/v1/comment-automations/{id}"
payload = {
"name": "Guide lead magnet",
"mediaIds": ["<string>"],
"keywords": ["guide", "link"],
"matchType": "contains",
"dmText": "<string>",
"dmButtonLabel": "<string>",
"dmButtonUrl": "<string>",
"publicReplyText": "<string>",
"oncePerUser": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Guide lead magnet',
mediaIds: ['<string>'],
keywords: ['guide', 'link'],
matchType: 'contains',
dmText: '<string>',
dmButtonLabel: '<string>',
dmButtonUrl: '<string>',
publicReplyText: '<string>',
oncePerUser: true
})
};
fetch('https://api.example.com/v1/comment-automations/{id}', 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.example.com/v1/comment-automations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Guide lead magnet',
'mediaIds' => [
'<string>'
],
'keywords' => [
'guide',
'link'
],
'matchType' => 'contains',
'dmText' => '<string>',
'dmButtonLabel' => '<string>',
'dmButtonUrl' => '<string>',
'publicReplyText' => '<string>',
'oncePerUser' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/comment-automations/{id}"
payload := strings.NewReader("{\n \"name\": \"Guide lead magnet\",\n \"mediaIds\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"guide\",\n \"link\"\n ],\n \"matchType\": \"contains\",\n \"dmText\": \"<string>\",\n \"dmButtonLabel\": \"<string>\",\n \"dmButtonUrl\": \"<string>\",\n \"publicReplyText\": \"<string>\",\n \"oncePerUser\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/v1/comment-automations/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Guide lead magnet\",\n \"mediaIds\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"guide\",\n \"link\"\n ],\n \"matchType\": \"contains\",\n \"dmText\": \"<string>\",\n \"dmButtonLabel\": \"<string>\",\n \"dmButtonUrl\": \"<string>\",\n \"publicReplyText\": \"<string>\",\n \"oncePerUser\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/comment-automations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Guide lead magnet\",\n \"mediaIds\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"guide\",\n \"link\"\n ],\n \"matchType\": \"contains\",\n \"dmText\": \"<string>\",\n \"dmButtonLabel\": \"<string>\",\n \"dmButtonUrl\": \"<string>\",\n \"publicReplyText\": \"<string>\",\n \"oncePerUser\": true\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Example:
"Guide lead magnet"
Platform media ids to watch (mediaId from get_account_media). Empty = every post on the account, including future ones.
Trigger words. Matching is case- and accent-insensitive. Required unless matchType is any.
Example:
["guide", "link"]
Available options:
contains, exact, any The DM sent to the commenter.
Button label (20 chars max shown). Empty removes the button, along with dmButtonUrl.
Button destination (https URL). Empty removes the button, along with dmButtonLabel.
Optional public reply posted under the comment.
Send at most one DM per person for this automation.
Available options:
active, paused Response
200 - undefined