Loading...
Overview

Account

Represents a customer organization in the digital customer platform, grouping users, devices, services, integrations, and related resources in a hierarchical account structure.

Attributes

These are all attributes that can be read and updated through the API

Name Description Permissions
id Unique identifier of the account. READ ONLY
name Name of the account. READ AND UPDATE
description Additional information or details about the account. READ AND UPDATE

Get Account by ID

GEThttps://48d4b327a2.autonoma.cloud/connect/v1/resources/account/[ID]

Returns a specific Account by ID.


Get Relations

It is possible to get related objects from Accounts.

GEThttps://48d4b327a2.autonoma.cloud/connect/v1/resources/account/[ID]/[RELATION]

This table shows all available resources that can be queried

Relation Objecttype Relationtype

Invite a user account

Creates an invitation for a user account with specified details and roles.

POSThttps://48d4b327a2.autonoma.cloud/connect/v1/resources/account/[ID]/call/invite

This table shows all available parameters

Name Description Required
firstname Given name of the user to be invited. required
lastname Family name of the user to be invited. required
email Email address used to send the invitation to the user. required
roles Role or roles to be associated with the invited user account. required

Update Account

POSThttps://48d4b327a2.autonoma.cloud/connect/v1/resources/account/[ID]

Update fields of Account by ID. The fields must be sent as x-www-form-urlencoded parameter.


Create Account

PUThttps://48d4b327a2.autonoma.cloud/connect/v1/resources/account

Create a new Account.


Delete Account

DELETEhttps://48d4b327a2.autonoma.cloud/connect/v1/resources/account/[ID]

Delete the resource Account by ID.

Top Top