Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The Account object represents an individual account in the SoftwareOne Marketplace.
This object contains the following attributes:
id
string, core
(Read-only) Unique identifier for the account.
type
string, core
The type of account. Allowed values are:
Client
Vendor
Operations
status
string, core
(Read-only) The status of the account. Allowed values are:
Enabled
Active
Disabled
name
string
The name of the account.
description
string
(Optional) A description of the account.
externalId
string
(Optional) The Customer Discount Group number.
externalName
string
The Customer Discount Group name.
serviceLevel
string
Service level for the account. Allowed values are:
Essential
Elite
DSC
address
object
The of the company.
icon
string, core
The relative path to the account's logo.
website
string
The path to the company’s website.
technicalSupportEmail
string
The email address for technical support.
audit
object
Represents the object.
groups
object
Represents the object.
buyers
object
Represents the object.
externalIDs
object
Represents the externalId for the account.
defaultLanguageCode
string
The default language code of the account.
{
"id": "ACC-1671-0642",
"type": "Client",
"status": "Enabled",
"name": "Stark industries",
"description": "Stark industries procurement team.",
"externalId": "WW-1001111",
"serviceLevel": "Express",
"address": {
"addressLine1": "123 Main Street",
"addressLine2": "Apt 4B",
"postCode": "12345",
"city": "Cityville",
"state": "S",
"country": "ST"
},
"logo": null,
"technicalSupportEmail": "jane@doe.com",
"website": "https://example.com"
}{
"id": "ACC-1671-0642",
"type": "Client",
"status": "Enabled",
"name": "Stark industries",
"description": "Stark industries procurement team.",
"externalId": "WW-1001111",
"serviceLevel": "Express",
"address": {
"addressLine1": "123 Main Street",
"addressLine2": "Apt 4B",
"postCode": "12345",
"city": "Cityville",
"state": "S",
"country": "ST"
},
"logo": null,
"technicalSupportEmail": "jane@doe.com",
"website": "https://janedoeexample.com",
"groups": [
{
"id": "UGR-9354-3382",
"name": "Administrators",
"description": "Manages administrative tasks and resources within an organization.",
"logo": null,
"isDefault": true
}
],
{
"created": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
"updated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
"disabled": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
"enabled": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
"activated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } }
}
}The Marketplace Platform provides three distinct user interfaces, namely the Client Portal, Vendor Portal, and Operations Portal. This topic describes how the account object transitions through different lifecycle states within the platform.
The following diagram shows how a client account moves between states like enable, activate, and disable.
The following diagram shows how a vendor account progresses between states.
New
This is the default state of a newly created account. This state is not visible on the interface.
Enabled
The account has been created, but it has not been fully set up yet in the system. While the account can be used for transactions, these transactions will not be completed.
Active
The account is fully operational in the Marketplace.
Disabled
The account is not available for transactions, and users cannot sign in or switch to this account.
Deactivate account. Moves the account from Active to Enabled. Available for Operations account with platform account management permissions. Returns the updated account object.
Account identifier.
OK
Bad Request
Not Found
POST /public/v1/accounts/accounts/{id}/deactivate HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "ACC-1234-1234",
"revision": 2,
"name": "Contoso Ltd",
"status": "Disabled",
"type": "Vendor",
"audit": {
"created": {
"at": "2024-01-15T09:12:23+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
},
"updated": {
"at": "2024-02-02T10:15:00+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
},
"activated": {
"at": "2024-02-02T15:15:00+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
},
"deactivated": {
"at": "2024-02-02T20:15:00+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
}
}
}Enable a disabled account. Available for Operations account with platform account management permissions. Moves the account to the Enabled state. Returns the updated account object.
Account identifier.
OK
Bad Request
Not Found
POST /public/v1/accounts/accounts/{id}/enable HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "ACC-1234-1234",
"revision": 2,
"name": "Contoso Ltd",
"status": "Enabled",
"type": "Vendor",
"audit": {
"created": {
"at": "2024-02-01T09:12:23+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
},
"updated": {
"at": "2024-02-02T10:00:00+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
},
"enabled": {
"at": "2024-02-02T10:00:00+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
}
}
}Get account icon by identifier. Access: Anonymous. Returns a redirect to the icon binary URL. Uses a private blob cache profile for the response.
Account identifier.
Temporary Redirect
No content
Not Found
GET /public/v1/accounts/accounts/{id}/icon HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Disable an active account. Access: Authenticated account with platform account management permissions. Moves the account to the Disabled state. Returns the updated account object.
Account identifier.
OK
Bad Request
Not Found
POST /public/v1/accounts/accounts/{id}/disable HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "ACC-1234-1234",
"revision": 2,
"name": "Contoso Ltd",
"status": "Disabled",
"type": "Vendor",
"audit": {
"created": {
"at": "2024-02-01T09:12:23+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
},
"updated": {
"at": "2024-02-02T10:05:00+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
},
"disabled": {
"at": "2024-02-02T10:05:00+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
}
}
}List accounts. Available for Operations account with platform account management permissions. Returns a paged list of accounts; supports RQL query parameters for filtering and selection.
OK
GET /public/v1/accounts/accounts HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"data": [
{
"id": "ACC-1234-1234",
"revision": 2,
"name": "Contoso Ltd",
"type": "Vendor",
"status": "Active",
"externalId": "WW-CON-123456"
}
],
"$meta": {
"pagination": {
"offset": 0,
"limit": 10,
"total": 1
}
}
}Get account by ID. Available for Operations account with platform account management permissions. Returns a single account with id, name, type, status, address, eligibility, and audit. Optional select query parameter controls which fields are returned.
Account identifier.
Optional RQL select statement to limit returned fields.
OK
Not Found
GET /public/v1/accounts/accounts/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "ACC-1234-1234",
"revision": 2,
"name": "Contoso Ltd",
"type": "Vendor",
"status": "Active",
"externalId": "WW-CON-123456",
"address": {
"addressLine1": "123 Main Street",
"postCode": "12345",
"city": "Cityville",
"state": "S",
"country": "ST"
},
"eligibility": {
"client": true,
"partner": false
}
}Activate account. Available for Operations account with platform account management permissions. Moves the account to Active state and sets the externalId from the request if sent. Returns the updated account object with audit.activated.
Account identifier.
OK
Bad Request
Not Found
POST /public/v1/accounts/accounts/{id}/activate HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"externalId": "WW-CON-123456"
}{
"id": "ACC-1234-1234",
"revision": 2,
"name": "Contoso Ltd",
"status": "Active",
"externalId": "WW-CON-123456",
"audit": {
"created": {
"at": "2024-02-01T09:12:23+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
},
"updated": {
"at": "2024-02-02T10:10:00+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
},
"activated": {
"at": "2024-02-02T10:10:00+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
}
}
}Create a new account. Available for Operations account with platform account management permissions. Creates account record and optional user groups/modules scope. When used Content-type: application/json - account created without icon. When used Content-type: multipart/form-data - account created with icon, parts should account and logo. Returns the created account object.
Created
Bad Request
POST /public/v1/accounts/accounts HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 868
{
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "name@gmail.com",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text",
"logo": "binary"
},
"logo": "binary"
}{
"id": "ACC-1234-1234",
"revision": 1,
"name": "Contoso Ltd",
"type": "Vendor",
"status": "Active",
"externalId": "WW-CON-123456",
"externalName": "Contoso",
"website": "https://contoso.com",
"description": "Enterprise customer account",
"address": {
"addressLine1": "123 Main Street",
"addressLine2": "Apt 4B",
"postCode": "12345",
"city": "Cityville",
"state": "S",
"country": "ST"
},
"eligibility": {
"client": true,
"partner": false
},
"audit": {
"created": {
"at": "2024-02-01T09:12:23+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
},
"updated": {
"at": "2024-02-01T09:12:23+00:00",
"by": {
"id": "USR-0001",
"name": "Ops User"
}
}
}
}Update account. Available for Operations account with platform account management permissions. Accepts application/json or multipart/form-data (with optional icon). Updates account fields such as name, address, website, and description. Returns the updated account object.
Account identifier.
OK
Bad Request
Not Found
PUT /public/v1/accounts/accounts/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 868
{
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "name@gmail.com",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text",
"logo": "binary"
},
"logo": "binary"
}{
"id": "ACC-1234-1234",
"revision": 2,
"name": "Contoso Ltd",
"icon": "/static/accounts/ACC-1234-1234/logo.png"
}Validate account payload and external identifiers. Available for Operations account with platform account management permissions. Returns validation result. Use this endpoint to check account externalId constraints before activation.
OK
Bad Request
POST /public/v1/accounts/accounts/{id}/validate HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"revision": 1,
"externalId": "WW-CON-123456"
}{
"revision": 2,
"externalId": "WW-CON-123456"
}