Skip to content
This repository was archived by the owner on Aug 27, 2021. It is now read-only.

Commit 4ee56cc

Browse files
authored
Merge pull request #1936 from sendgrid/add_mail_settings_endpoints
Add New Inbound Parse Webhook API docs
2 parents 46a750d + 64362e7 commit 4ee56cc

File tree

2 files changed

+112
-25
lines changed

2 files changed

+112
-25
lines changed
Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
layout: page
3+
title: Parse API
4+
weight: 80
5+
navigation:
6+
show: true
7+
---
8+
FORMAT: 1A
9+
10+
The following Parse API settings allow you to manage the [Inbound Parse Webhook]({{root_url}}/API_Reference/Webhooks/parse.html).
11+
12+
## Parse Settings Collection [/user/webhooks/parse/settings?limit={limit}&offset={offset}]
13+
14+
### Get Parse Settings [GET]
15+
16+
Retrieves all of your current inbound parse settings.
17+
18+
+ Parameters
19+
+ limit (optional, number, `20`) ... Number of settings to return.
20+
+ offset (optional, number, `1`) ... Paging offset.
21+
22+
+ Response 200 (application/json)
23+
24+
+ Body
25+
26+
{
27+
"result":
28+
[
29+
{
30+
"url": "http://mydomain.com/parse",
31+
"hostname": "mail.mydomain.com",
32+
"spam_check": true,
33+
"send_raw": true
34+
}
35+
]
36+
}
37+
38+
## Parse Settings Create Resource [/user/webhooks/parse/settings]
39+
40+
### Create Parse Setting [POST]
41+
42+
Creates a new inbound parse setting.
43+
44+
+ Request (application/json)
45+
46+
+ Body
47+
48+
{
49+
"hostname": "myhostname.com",
50+
"url": "http://email.myhosthame.com",
51+
"spam_check": true,
52+
"send_raw": false
53+
}
54+
55+
+ Response 201 (application/json)
56+
57+
+ Body
58+
59+
{
60+
"url": "http://email.myhostname.com",
61+
"hostname": "myhostname.com",
62+
"spam_check": false,
63+
"send_raw": true
64+
}
65+
66+
## Parse Settings Resource [/user/webhooks/parse/settings/{hostname}]
67+
68+
### Get Parse Setting [GET]
69+
70+
Retrieves a specific inbound parse setting.
71+
72+
+ Response 200 (application/json)
73+
74+
+ Body
75+
76+
{
77+
"url": "http://mydomain.com/parse",
78+
"hostname": "mail.mydomain.com",
79+
"spam_check": true,
80+
"send_raw": true
81+
}
82+
83+
### Update Parse Setting [PATCH]
84+
85+
Updates one of your current inbound parse settings.
86+
87+
+ Request (application/json)
88+
89+
+ Body
90+
91+
{
92+
"url": "http://newdomain.com/parse",
93+
"spam_check": false,
94+
"send_raw": true
95+
}
96+
97+
+ Response 200 (application/json)
98+
99+
+ Body
100+
101+
{
102+
"url": "http://mydomain.com/parse",
103+
"hostname": "mail.mydomain.com",
104+
"spam_check": true,
105+
"send_raw": true
106+
}
107+
108+
### Delete Parse Setting [DELETE]
109+
110+
Deletes one of your current inbound parse settings.
111+
112+
+ Response 204 (application/json)

source/API_Reference/Web_API_v3/Webhooks/parse.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

0 commit comments

Comments
 (0)