Merge branch 'master' of github.com:Mailtrain-org/mailtrain into access
Conflicts: views/users/api.hbs
This commit is contained in:
commit
ad1e4c58f5
21 changed files with 5088 additions and 284 deletions
|
@ -179,6 +179,54 @@ export default class API extends Component {
|
|||
<pre>curl -XPOST {serviceUrl}api/delete/B16uVTdW?access_token={accessToken} \
|
||||
--data 'EMAIL=test@example.com'</pre>
|
||||
|
||||
<h3>POST /api/field/:listId – {t('Add new custom field')}</h3>
|
||||
|
||||
<p>
|
||||
{t('This API call creates a new custom field for a list.')}
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<strong>GET</strong> {t('arguments')}
|
||||
</p>
|
||||
<ul>
|
||||
<li><strong>access_token</strong> – {t('your personal access token')}</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
<strong>POST</strong> {t('arguments')}
|
||||
</p>
|
||||
<ul>
|
||||
<li><strong>NAME</strong> – {t('field name')} (<em>{t('required')}</em>)</li>
|
||||
<li><strong>TYPE</strong> – {t('one of the following types:')}
|
||||
<ul>
|
||||
<li><strong>text</strong> Text</li>
|
||||
<li><strong>website</strong> Website</li>
|
||||
<li><strong>longtext</strong> Multi-line text</li>
|
||||
<li><strong>gpg</strong> GPG Public Key</li>
|
||||
<li><strong>number</strong> Number</li>
|
||||
<li><strong>radio</strong> Radio Buttons</li>
|
||||
<li><strong>checkbox</strong> Checkboxes</li>
|
||||
<li><strong>dropdown</strong> Drop Down</li>
|
||||
<li><strong>date-us</strong> Date (MM/DD/YYY)</li>
|
||||
<li><strong>date-eur</strong> Date (DD/MM/YYYY)</li>
|
||||
<li><strong>birthday-us</strong> Birthday (MM/DD)</li>
|
||||
<li><strong>birthday-eur</strong> Birthday (DD/MM)</li>
|
||||
<li><strong>json</strong> JSON value for custom rendering</li>
|
||||
<li><strong>option</strong> Option</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>GROUP</strong> – {t('If the type is 'option' then you also need to specify the parent element ID')}</li>
|
||||
<li><strong>GROUP_TEMPLATE</strong> – {t('Template for the group element. If not set, then values of the elements are joined with commas')}</li>
|
||||
<li><strong>VISIBLE</strong> – yes/no, {t('if not visible then the subscriber can not view or modify this value at the profile page')}</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
<strong>{t('Example')}</strong>
|
||||
</p>
|
||||
|
||||
<pre>curl -XPOST {{serviceUrl}}api/field/B16uVTdW?access_token={{accessToken}} \
|
||||
--data 'NAME=Birthday&TYPE=birthday-us&VISIBLE=yes'</pre>
|
||||
|
||||
<h3>GET /api/blacklist/get – {t('Get list of blacklisted emails')}</h3>
|
||||
|
||||
<p>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue