{ "opencollection": "1.0.0", "info": { "name": "Phrase Strings API Reference Accounts Automations API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Automations", "type": "folder" }, "items": [ { "info": { "name": "List automations", "type": "http" }, "http": { "method": "GET", "url": "https://api.phrase.com/v2/accounts/:account_id/automations", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" }, { "name": "page", "value": "1", "type": "query", "description": "Page number" }, { "name": "per_page", "value": "25", "type": "query", "description": "Limit on the number of objects to be returned, between 1 and 100. 25 by default" } ] }, "docs": "List all automations for an account.\n\nFor feature availability, see [Jobs (Strings)](https://support.phrase.com/hc/en-us/articles/5784100517788-Jobs-Strings).\n" }, { "info": { "name": "Create an automation", "type": "http" }, "http": { "method": "POST", "url": "https://api.phrase.com/v2/accounts/:account_id/automations", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new automation.\n\nFor feature availability, see [Jobs (Strings)](https://support.phrase.com/hc/en-us/articles/5784100517788-Jobs-Strings).\n" }, { "info": { "name": "Get a single automation", "type": "http" }, "http": { "method": "GET", "url": "https://api.phrase.com/v2/accounts/:account_id/automations/:automation_id", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Get details of a single automation.\n\nFor feature availability, see [Jobs (Strings)](https://support.phrase.com/hc/en-us/articles/5784100517788-Jobs-Strings).\n" }, { "info": { "name": "Update an automation", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.phrase.com/v2/accounts/:account_id/automations/:automation_id", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing automation.\n\nFor feature availability, see [Jobs (Strings)](https://support.phrase.com/hc/en-us/articles/5784100517788-Jobs-Strings).\n" }, { "info": { "name": "Destroy automation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.phrase.com/v2/accounts/:account_id/automations/:automation_id", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Destroy an automation of an account.\n\nFor feature availability, see [Jobs (Strings)](https://support.phrase.com/hc/en-us/articles/5784100517788-Jobs-Strings).\n" }, { "info": { "name": "Activate an automation", "type": "http" }, "http": { "method": "POST", "url": "https://api.phrase.com/v2/accounts/:account_id/automations/:automation_id/activate", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Activate an automation.\n\nFor feature availability, see [Jobs (Strings)](https://support.phrase.com/hc/en-us/articles/5784100517788-Jobs-Strings).\n" }, { "info": { "name": "Deactivate an automation", "type": "http" }, "http": { "method": "POST", "url": "https://api.phrase.com/v2/accounts/:account_id/automations/:automation_id/deactivate", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Deactivate an automation.\n\nFor feature availability, see [Jobs (Strings)](https://support.phrase.com/hc/en-us/articles/5784100517788-Jobs-Strings).\n" }, { "info": { "name": "Trigger an automation", "type": "http" }, "http": { "method": "POST", "url": "https://api.phrase.com/v2/accounts/:account_id/automations/:automation_id/trigger", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Trigger an automation.\n" } ] } ], "bundled": true }