Skip to content

Commit

Permalink
Fix incorrent curl command in docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
knadh committed Nov 25, 2024
1 parent fce46b2 commit 3f5bad1
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 22 deletions.
6 changes: 3 additions & 3 deletions docs/docs/content/apis/bounces.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ To delete all bounces.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/bounces?all=true'
curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/bounces?all=true'
```

##### Example Response
Expand All @@ -120,7 +120,7 @@ To delete multiple bounce records.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/bounces?id=840965&id=840168&id=840879'
curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/bounces?id=840965&id=840168&id=840879'
```

##### Example Response
Expand All @@ -140,7 +140,7 @@ To delete specific bounce id.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/bounces/840965'
curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/bounces/840965'
```

##### Example Response
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/content/apis/lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ Delete a specific subscriber.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/lists/1'
curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/lists/1'
```

##### Example Response
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/content/apis/media.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Retrieve a specific media.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/media/7'
curl -u 'api_username:access_token' 'http://localhost:9000/api/media/7'
```

##### Example Response
Expand Down
32 changes: 16 additions & 16 deletions docs/docs/content/apis/subscribers.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ Retrieve all subscribers.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers?page=1&per_page=100'
curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers?page=1&per_page=100'
```

```shell
curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers?list_id=1&list_id=2&page=1&per_page=100'
curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers?list_id=1&list_id=2&page=1&per_page=100'
```

```shell
curl -u curl -u 'api_username:access_token' -X GET 'http://localhost:9000/api/subscribers' \
curl -u 'api_username:access_token' -X GET 'http://localhost:9000/api/subscribers' \
--url-query 'page=1' \
--url-query 'per_page=100' \
--url-query "query=subscribers.name LIKE 'Test%' AND subscribers.attribs->>'city' = 'Bengaluru'"
Expand Down Expand Up @@ -147,7 +147,7 @@ Retrieve a specific subscriber.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/1'
curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/1'
```

##### Example Response
Expand Down Expand Up @@ -199,7 +199,7 @@ Export a specific subscriber data that gives profile, list subscriptions, campai
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/1/export'
curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/1/export'
```

##### Example Response
Expand Down Expand Up @@ -248,7 +248,7 @@ Get a specific subscriber bounce records.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/1/bounces'
curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/1/bounces'
```

##### Example Response
Expand Down Expand Up @@ -312,7 +312,7 @@ Create a new subscriber.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers' -H 'Content-Type: application/json' \
curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers' -H 'Content-Type: application/json' \
--data '{"email":"subsriber@domain.com","name":"The Subscriber","status":"enabled","lists":[1],"attribs":{"city":"Bengaluru","projects":3,"stack":{"languages":["go","python"]}}}'
```

Expand Down Expand Up @@ -347,7 +347,7 @@ Sends optin confirmation email to subscribers.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/11/optin' -H 'Content-Type: application/json' \
curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/11/optin' -H 'Content-Type: application/json' \
--data {}
```

Expand Down Expand Up @@ -414,7 +414,7 @@ Modify subscriber list memberships.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' -X PUT 'http://localhost:9000/api/subscribers/lists' \
curl -u 'api_username:access_token' -X PUT 'http://localhost:9000/api/subscribers/lists' \
-H 'Content-Type: application/json' \
--data-raw '{"ids": [1, 2, 3], "action": "add", "target_list_ids": [4, 5, 6], "status": "confirmed"}'
```
Expand Down Expand Up @@ -450,7 +450,7 @@ Blocklist a specific subscriber.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' -X PUT 'http://localhost:9000/api/subscribers/9/blocklist'
curl -u 'api_username:access_token' -X PUT 'http://localhost:9000/api/subscribers/9/blocklist'
```

##### Example Response
Expand All @@ -476,7 +476,7 @@ Blocklist multiple subscriber.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' -X PUT 'http://localhost:8080/api/subscribers/blocklist' -H 'Content-Type: application/json' --data-raw '{"ids":[2,1]}'
curl -u 'api_username:access_token' -X PUT 'http://localhost:8080/api/subscribers/blocklist' -H 'Content-Type: application/json' --data-raw '{"ids":[2,1]}'
```

##### Example Response
Expand Down Expand Up @@ -505,7 +505,7 @@ Blocklist subscribers based on SQL expression.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' -X POST 'http://localhost:9000/api/subscribers/query/blocklist' \
curl -u 'api_username:access_token' -X POST 'http://localhost:9000/api/subscribers/query/blocklist' \
-H 'Content-Type: application/json' \
--data-raw '{"query":"subscribers.name LIKE \'John Doe\' AND subscribers.attribs->>'\''city'\'' = '\''Bengaluru'\''"}'
```
Expand Down Expand Up @@ -533,7 +533,7 @@ Delete a specific subscriber.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/subscribers/9'
curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/subscribers/9'
```

##### Example Response
Expand All @@ -559,7 +559,7 @@ Delete a subscriber's bounce records
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/subscribers/9/bounces'
curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/subscribers/9/bounces'
```

##### Example Response
Expand All @@ -585,7 +585,7 @@ Delete one or more subscribers.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/subscribers?id=10&id=11'
curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/subscribers?id=10&id=11'
```

##### Example Response
Expand Down Expand Up @@ -613,7 +613,7 @@ Delete subscribers based on SQL expression.
##### Example Request

```shell
curl -u curl -u 'api_username:access_token' -X POST 'http://localhost:9000/api/subscribers/query/delete' \
curl -u 'api_username:access_token' -X POST 'http://localhost:9000/api/subscribers/query/delete' \
-H 'Content-Type: application/json' \
--data-raw '{"query":"subscribers.name LIKE \'John Doe\' AND subscribers.attribs->>'\''city'\'' = '\''Bengaluru'\''"}'
```
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/content/bounces.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The bounce webhook API can be used to record bounce events with custom scripting


```shell
curl -u curl -u 'api_username:access_token' -X POST 'http://localhost:9000/webhooks/bounce' \
curl -u 'api_username:access_token' -X POST 'http://localhost:9000/webhooks/bounce' \
-H "Content-Type: application/json" \
--data '{"email": "user1@mail.com", "campaign_uuid": "9f86b50d-5711-41c8-ab03-bc91c43d711b", "source": "api", "type": "hard", "meta": "{\"additional\": \"info\"}}'

Expand Down

0 comments on commit 3f5bad1

Please sign in to comment.