← Configuration API

PostalCodes

Singular: PostalCode — Base URL: https://config-api.ayoune.app — Access: CRUD

Endpoints

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

SDK

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

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

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

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

See also

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