accounts

Edit account information (name and status)

[Protected by accounts_manage scope] This endpoint allows to replace name and status values. It is possible to archive or unarchive an account by using its status. CLOSED = account will be archived, ACTIVE = archived account will be re-opened. A closed account will not be synchronized. Activate an account will schedule a synchronization. This endpoint allows to handle the use case of profesional accounts. More information about professional accounts

put/accounts/{id}

Request

  • Base URL: https://api.linxo.com/v2
  • URL: https://api.linxo.com/v2/accounts/{id}
  • Auth: OAuth (defined in the document in a form this page cannot read)

Path parameters

idstring required

Identifier of the account

Headers

Authorizationstring

Provided Bearer token following the format: 'Bearer xxxxxxxxx'

Request body

namestring required

Name of the account. If the value is different than the current name, the account will be updated, otherwise, the account name will remain unchanged

status'MANUAL' | 'ACTIVE' | 'ERROR' | 'NOT_FOUND' | 'CLOSED' | 'SUSPENDED' | 'PENDING_CONSENT' required

Status of the account. If the value sent is ACTIVE while the status of the account is CLOSED, then the account will be unarchived and a synchronization will be triggered. If the value sent is CLOSED while the account status is ACTIVE, then the account will be archived. No more synchronization will be done on this account as long as it is archived. If the value is not CLOSED or ACTIVE then the status will remain unchanged.

optinboolean

Corporate account optin choice. Set it to true if you want to use our services for this corporate account.

identification_numberstring required

The identification number of the entity (company, association or other) authorized to access the account.

corporate_type'RNA' | 'SIREN' | 'OTHER' required

The account corporation type: RNA, SIREN, OTHER

usage'PERSONAL' | 'PROFESSIONAL'

Whether you want to declare as PERSONAL an account seen as PROFESSIONAL.

Response

Account successfully updated

Changes

No recorded changes to this operation across all 1 revision of this API.