public/mailtrain
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Added documentation for API endpoint /api/field/:listId

Browse source 
This has accidentally been removed with PR #203.
This commit is contained in:
witzig 2017-07-06 15:03:04 +02:00
parent 622a23959b
commit bd570000e1
1 changed files with 39 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

39
views/users/api.hbs
View file

@ -142,6 +142,45 @@
<pre>curl -XPOST {{serviceUrl}}api/delete/B16uVTdW?access_token={{accessToken}} \ <pre>curl -XPOST {{serviceUrl}}api/delete/B16uVTdW?access_token={{accessToken}} \
--data 'EMAIL=test@example.com'</pre> --data 'EMAIL=test@example.com'</pre>
<h3>POST /api/field/:listId – {{#translate}}Add new custom field{{/translate}}</h3>
<p>
{{#translate}}This API call creates a new custom field for a list.{{/translate}}
</p>
<p>
<strong>GET</strong> {{#translate}}arguments{{/translate}}
</p>
<ul>
<li><strong>access_token</strong> – {{#translate}}your personal access token{{/translate}}
</ul>
<p>
<strong>POST</strong> {{#translate}}arguments{{/translate}}
</p>
<ul>
<li><strong>NAME</strong> – {{#translate}}field name{{/translate}} (<em>{{#translate}}required{{/translate}}</em>)</li>
<li><strong>TYPE</strong> – {{#translate}}one of the following types:{{/translate}}
<ul>
{{#each allowedTypes}}
<li>
<strong>{{type}}</strong> {{description}}
</li>
{{/each}}
</ul>
</li>
<li><strong>GROUP</strong> – {{#translate}}If the type is 'option' then you also need to specify the parent element ID{{/translate}}</li>
<li><strong>GROUP_TEMPLATE</strong> – {{#translate}}Template for the group element. If not set, then values of the elements are joined with commas{{/translate}}</li>
<li><strong>VISIBLE</strong> – yes/no, {{#translate}}if not visible then the subscriber can not view or modify this value at the profile page{{/translate}}</li>
</ul>
<p>
<strong>{{#translate}}Example{{/translate}}</strong>
</p>
<pre>curl -XPOST {{serviceUrl}}api/field/B16uVTdW?access_token={{accessToken}} \
--data 'NAME=Birthday&amp;TYPE=birthday-us&amp;VISIBLE=yes'</pre>
<h3>GET /api/blacklist/get – {{#translate}}Get list of blacklisted emails{{/translate}}</h3> <h3>GET /api/blacklist/get – {{#translate}}Get list of blacklisted emails{{/translate}}</h3>
<p> <p>