Skip to main content
PATCH
/
accounts
/
{id}
Update Account
curl --request PATCH \
  --url https://api.stackone.com/accounts/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "origin_owner_id": "<string>",
  "origin_owner_name": "<string>",
  "origin_username": "<string>",
  "credentials": {},
  "setup_information": {},
  "secrets": {},
  "authentication_config_key": "<string>",
  "environment": "<string>",
  "label": {},
  "metadata": {},
  "type": [
    "PRODUCTION",
    "TEST"
  ],
  "integration_id": "<string>",
  "connector_profile_id": "<string>",
  "shared": true
}
'
{
  "id": "<string>",
  "provider": "<string>",
  "origin_owner_id": "<string>",
  "origin_owner_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "provider_name": "<string>",
  "categories": [
    "hris",
    "ats"
  ],
  "status_reasons": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "code": "<string>",
      "description": "<string>"
    }
  ],
  "origin_username": "<string>",
  "credentials": {},
  "setup_information": {},
  "label": "<string>",
  "type": [
    "PRODUCTION",
    "TEST"
  ],
  "shared": true
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

Body

application/json
​
provider
string | null
​
origin_owner_id
string | null
​
origin_owner_name
string | null
​
origin_username
string | null
​
credentials
object
​
setup_information
object
​
secrets
object
​
authentication_config_key
string | null
​
environment
string | null
​
label
object
​
metadata
object
​
type
enum<string> | null

The account type

Available options:
production,
test,
null
Example:
["PRODUCTION", "TEST"]
​
integration_id
string | null
deprecated

Deprecated: use connector_profile_id instead.

​
connector_profile_id
string | null

The ID of the connector profile to associate the account with.

​
shared
boolean | null

Response

The account with the given identifier was updated.

​
id
string
required
​
provider
string
required
​
status
enum<string>
required
Available options:
active,
inactive,
suspended,
archived,
expired,
error
​
origin_owner_id
string
required
​
origin_owner_name
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
provider_name
string | null
​
categories
string[] | null

The categories this provider belongs to (e.g., hris, ats, crm)

Example:
["hris", "ats"]
​
status_reasons
object[] | null
​
origin_username
string | null
​
credentials
object
​
setup_information
object
​
label
string | null
​
type
enum<string> | null

The account type

Available options:
production,
test,
unmapped_value,
null
Example:
["PRODUCTION", "TEST"]
​
shared
boolean | null