SAP Cloud Platform Open Connectors

POST /accounts

POST /accounts

As an organization administrator, you can add an account to your organization. Accounts typically represent your customer.

Request Body Parameters

Field
Description
Required
Type
active
Indicates if the account is active. In the JSON response true is active and false is inactive.
N
Boolean
name
The name of the account.
Y
string
description
A brief description of the account.
Y
string
externalId
A unique identifier for the account, required to add an account using POST/ accounts.
Y
string

Example Request

curl -X POST \
  https://api.openconnectors.us2.ext.hana.ondemand.com/elements/api-v2/accounts \
  -H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \
  -H 'content-type: application/json' \
  -d '{
  "name": "Account For Docs",
  "description": "This account is used to demonstrate a POST /accounts request",
  "externalId": "notsorandomId"
}
'

Example Response

{
    "id": 4030,
    "name": "Account For Docs",
    "description": "This account is used to demonstrate a POST /accounts request",
    "active": true,
    "companyId": 819,
    "externalId": "notsorandomId",
    "defaultAccount": false,
    "type": "CompanyAccount"
}