cURL
curl "https://api.phrase.com/v2/accounts/:account_id/automations/:id/activate" \
-u USERNAME_OR_ACCESS_TOKEN \
-X POST \
-H 'Content-Type: application/json'phrase automations activate \
--account_id <account_id> \
--id <id> \
--access_token <token>import requests
url = "https://api.phrase.com/v2/accounts/{account_id}/automations/{automation_id}/activate"
headers = {"Authorization": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://api.phrase.com/v2/accounts/{account_id}/automations/{automation_id}/activate', 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.phrase.com/v2/accounts/{account_id}/automations/{automation_id}/activate",
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: <api-key>"
],
]);
$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.phrase.com/v2/accounts/{account_id}/automations/{automation_id}/activate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<api-key>")
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.phrase.com/v2/accounts/{account_id}/automations/{automation_id}/activate")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.phrase.com/v2/accounts/{account_id}/automations/{automation_id}/activate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "My First Automation",
"status": "active",
"trigger": "schedule",
"status_filters": [
"unverified",
"untranslated",
"ready_for_review"
],
"project_id": "abcd1234cdef1234abcd1234cdef1234",
"job_template_id": "abcd1234cdef1234abcd1234cdef1234",
"tags": [
"tag-1",
"tag-2"
],
"cron_schedule": "00 13 * * 1,2",
"time_zone": "GMT",
"account": "account",
"created_at": "2021-06-28T09:52:53Z",
"updated_at": "2021-06-28T09:52:53Z"
}{
"message": "Validation Failed",
"errors": [
{
"resource": "Resource",
"field": "name",
"message": "can't be blank"
}
]
}Automations
Activate an automation
Activate an automation.
For feature availability, see Jobs (Strings).
POST
/
accounts
/
{account_id}
/
automations
/
{automation_id}
/
activate
cURL
curl "https://api.phrase.com/v2/accounts/:account_id/automations/:id/activate" \
-u USERNAME_OR_ACCESS_TOKEN \
-X POST \
-H 'Content-Type: application/json'phrase automations activate \
--account_id <account_id> \
--id <id> \
--access_token <token>import requests
url = "https://api.phrase.com/v2/accounts/{account_id}/automations/{automation_id}/activate"
headers = {"Authorization": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://api.phrase.com/v2/accounts/{account_id}/automations/{automation_id}/activate', 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.phrase.com/v2/accounts/{account_id}/automations/{automation_id}/activate",
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: <api-key>"
],
]);
$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.phrase.com/v2/accounts/{account_id}/automations/{automation_id}/activate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<api-key>")
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.phrase.com/v2/accounts/{account_id}/automations/{automation_id}/activate")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.phrase.com/v2/accounts/{account_id}/automations/{automation_id}/activate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "My First Automation",
"status": "active",
"trigger": "schedule",
"status_filters": [
"unverified",
"untranslated",
"ready_for_review"
],
"project_id": "abcd1234cdef1234abcd1234cdef1234",
"job_template_id": "abcd1234cdef1234abcd1234cdef1234",
"tags": [
"tag-1",
"tag-2"
],
"cron_schedule": "00 13 * * 1,2",
"time_zone": "GMT",
"account": "account",
"created_at": "2021-06-28T09:52:53Z",
"updated_at": "2021-06-28T09:52:53Z"
}{
"message": "Validation Failed",
"errors": [
{
"resource": "Resource",
"field": "name",
"message": "can't be blank"
}
]
}Authorizations
TokenBasic
Enter your token in the format token TOKEN
Headers
Two-Factor-Authentication token (optional)
Response
OK
Available options:
inactive, active, error Available options:
schedule, upload translation key statuses used to filter keys that are added to jobs
Available options:
unverified, untranslated, ready_for_review All project IDs the automation applies to. Returned alongside the singular project_id for backwards compatibility.
User ID of the job owner that newly created jobs are assigned to.
When true, the automation only acts on locales that changed since its last run.
Show child attributes
Show child attributes
Example:
{
"id": "abcd1234",
"name": "Company Account",
"slug": "company_account",
"company": "My Awesome Company",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z",
"company_logo_url": "http://assets.example.com/company_logo.png"
}
Was this page helpful?