Skip to content

Commit d449eca

Browse files
add trigger doc
1 parent 0312fe3 commit d449eca

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

paths/automations/trigger.yaml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
summary: Trigger an automation
3+
description: |
4+
Trigger an automation.
5+
operationId: automation/trigger
6+
tags:
7+
- Automations
8+
parameters:
9+
- "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
10+
- "$ref": "../../parameters.yaml#/account_id"
11+
- "$ref": "../../parameters.yaml#/id"
12+
responses:
13+
'200':
14+
description: OK
15+
content:
16+
application/json:
17+
schema:
18+
"$ref": "../../schemas/automation.yaml#/automation"
19+
headers:
20+
X-Rate-Limit-Limit:
21+
"$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
22+
X-Rate-Limit-Remaining:
23+
"$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
24+
X-Rate-Limit-Reset:
25+
"$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
26+
'400':
27+
"$ref": "../../responses.yaml#/400"
28+
'404':
29+
"$ref": "../../responses.yaml#/404"
30+
'429':
31+
"$ref": "../../responses.yaml#/429"
32+
x-code-samples:
33+
- lang: Curl
34+
source: |-
35+
curl "https://api.phrase.com/v2/accounts/:account_id/automations/:id/trigger" \
36+
-u USERNAME_OR_ACCESS_TOKEN
37+
-X POST
38+
-H 'Content-Type: application/json'
39+
- lang: CLI v2
40+
source: |-
41+
phrase automations trigger \
42+
--account_id <account_id> \
43+
--id <id> \
44+
--access_token <token>

0 commit comments

Comments
 (0)