← Configuration API

Mailboxes

Singular: Mailbox — Base URL: https://config-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

Endpoints

Method	Path	Description	Right
GET	/mailboxes	List with filters/pagination	config.mailboxes.view
GET	/mailboxes/:id	Single record	config.mailboxes.view
POST	/mailboxes	Create new record	config.mailboxes.new
PUT	/mailboxes	Update record	config.mailboxes.edit
DELETE	/mailboxes/:id	Delete record	config.mailboxes.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.config.mailboxes.find().limit(10).exec();

// Single record
const one = await ay.config.mailboxes.findById('OBJECT_ID').exec();

// Create
const created = await ay.config.mailboxes.create({ name: 'Foo' });

See also

• Long-form guide in the documentation
• Authentication
• Errors & Rate Limits