Skip to content

Commit 0deb120

Browse files
committed
feat: notes about a channel
1 parent 8d0aedc commit 0deb120

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

pages/public-api.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ Here are the following API endpoints you can use:
2727

2828
<br />
2929

30-
### Get all added integrations
30+
> NOTE: The UI representation is a `channel`, but on the API it is called `integration`. So when you see `integration` in the API, it means a `channel`.
31+
32+
### Get all added channels
3133

3234
```http
3335
GET https://api.postiz.com/public/v1/integrations
@@ -136,7 +138,7 @@ Payload:
136138
"posts": [
137139
{
138140
"integration": {
139-
"id": "asdfsad23rwdfasfsddc"
141+
"id": "asdfsad23rwdfasfsddc" // your channel id
140142
},
141143
"value": [
142144
{
@@ -152,7 +154,7 @@ Payload:
152154
],
153155
"group": "uniqueId for all the posts in the same group",
154156
"settings": {
155-
"[key]": "check each integration DTOs in the files, or wait for the error on a new request"
157+
"[key]": "check each channel DTOs in the files, or wait for the error on a new request"
156158
}
157159
}
158160
]

0 commit comments

Comments
 (0)