PATCH
/
v1
/
accounts
/
{accountId}
curl --request PATCH \
  --url https://live.copilot.fabric.inc/data-customer/v1/accounts/{accountId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "isDeleted": true,
  "parentAccountId": "612d66416c6ce700086e887d",
  "type": "The type parameter.",
  "name": "The name parameter.",
  "accountNumber": "The account number you wish to use.",
  "additionalAttributes": {},
  "createdAt": "2021-08-30T23:14:43.111Z",
  "updatedAt": "2021-08-30T23:14:43.111Z"
}'
{
  "isDeleted": true,
  "_id": "612d66636c6ce700086e8880",
  "parentAccountId": "612d66416c6ce700086e887d",
  "type": "The type parameter.",
  "name": "The name parameter.",
  "accountNumber": "The account number you wish to use.",
  "additionalAttributes": {},
  "createdAt": "2021-08-30T23:14:43.111Z",
  "updatedAt": "2021-08-30T23:14:43.111Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
accountId
string
required

Fabric internal id of the record

Example:

"61bb7e25fc2a2f00085ef23a"

Body

application/json
A sample request to update an account.
​
parentAccountId
string
required
Example:

"612d66416c6ce700086e887d"

​
type
string
required
Example:

"The type parameter."

​
name
string
required
Example:

"The name parameter."

​
accountNumber
string
required
Example:

"The account number you wish to use."

​
isDeleted
boolean
Example:

true

​
additionalAttributes
object

Contains all additional attributes not captured in the schema.

​
createdAt
string
Example:

"2021-08-30T23:14:43.111Z"

​
updatedAt
string
Example:

"2021-08-30T23:14:43.111Z"

Response

200
application/json
OK
​
isDeleted
boolean
required
Example:

true

​
_id
string
required

Fabric internal id of the record.

Example:

"612d66636c6ce700086e8880"

​
createdAt
string
required
Example:

"2021-08-30T23:14:43.111Z"

​
updatedAt
string
required
Example:

"2021-08-30T23:14:43.111Z"

​
parentAccountId
string
Example:

"612d66416c6ce700086e887d"

​
type
string
Example:

"The type parameter."

​
name
string
Example:

"The name parameter."

​
accountNumber
string
Example:

"The account number you wish to use."

​
additionalAttributes
object

Contains all additional attributes not captured in the schema.

Was this page helpful?