API Reference
  1. Ophelos API
  2. Organisation Management

Create an organisation

post
https://api.ophelos.dev/organisations

Create a new organisation for managing debts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Organisation represents the entity that manages debts and customers.

string
required
length between 1 and 128

The organisation's name used when displaying to customers.

string
required
length between 1 and 128

The organisation's name used in internal systems.

string
length ≤ 128

The organisation's specific sector in which it operates, based on the primary activities or products.

string
length ≤ 128

The URL where the organisation's logo image is available.

contact_details
array of objects
contact_details
configurations
object

A set of configurations that define the behaviour of all debts within this organisation. These configurations override any corresponding settings at the tenant or market level. They filter down to individual debts where they are calculated and control how debts should be managed, unless explicitly overridden at the debt level.

metadata
object

A set of key-value pairs that you can attach to a organisation object. It can be useful for storing additional information about the organisation in a structured format.

payment_options_configuration
object

Configuration for payment options available to this organisation's customers.

payment_plan_configuration
object

Configuration for payment plans within the organisation.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 2 months ago

Did this page help you?