Edit a User

patch

https://api.sandbox.helloaria.eu/companies/{companyId}/user/{userId}

Path Params

companyId

string

required

Defaults to me

userId

string

required

Body Params

phone

string

Phone number of the user

string

required

Email of the user

givenName

string

Given or first name of the user

familyName

string

Family or last name of the user

address

object

siren

string

deprecated

SIREN of user's company/business

businessIdentifier

object

Business identifier of the client being invoiced.

businessName

string

Name of user's company/business

canBeInvoiceOwner

boolean

Define if the User could be the true ultimate owner of Invoices you'll be sending us. When set as true, a KYC/KYB of the company will be required to prevent Loan future rejections. When not filled, it will be automatically set as true.

businessType

string

enum

Type of business the User is running. INDIVIDUAL is synonymous with a sole proprietorship, where the individual owner is personally responsible for all aspects of the business (i.e freelancer).

Allowed:

IBAN

string

deprecated

IBAN of the BankAccount. Must be in the correct European format.

paymentDestinations

array of objects

paymentDestinations

Headers

x-end-user-ip

string

IP of the end-user doing the action resulting in the API call.

Responses

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully updated user

403Not permitted (e.g trying to update a user of a company other than yours)