Updates my tenant

Updates Tenant details

Note: This endpoint is not implemented yet.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
expand[]
array of strings

Specify fields to expand in the response.

Multiple fields can be expanded by providing the parameter multiple times.

expand[]
Allowed:
Body Params
configurations
object

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

metadata
object

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

string

The namespace of the tenant. This is used to identify the tenant in a multi-tenant environment.

string

The client name used for letters sent by this tenant.

string

The name used in the "From" field of emails sent by this tenant.

number

The TrustPilot score for the tenant.

stripe_connect_account
object

Account id for the tenant's stripe connect account.

contact_details
array of objects

The contact details associated with the tenant. Each contact detail can be of different types such as email or phone number.

contact_details
Responses

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