PATCH
/
v1
/
contracts
/
{contractId}
curl --request PATCH \
  --url https://live.copilot.fabric.inc/data-customer/v1/contracts/{contractId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "partyId": "61a77df3941da90009fd35db",
  "addressId": "6182ae91c67c61932b38c382",
  "accountId": "6182aeb6c67c61932b38c38b",
  "status": "ACTIVE",
  "contractType": "TYPE-A",
  "onContract": true,
  "promotionStacking": true,
  "priceListId": 100000,
  "startDate": "2021-08-19T15:16:20.630Z",
  "endDate": "2021-12-20T15:16:20.630Z",
  "additionalAttributes": {}
}'
{
  "_id": "61604a30fdfacd0009816e44",
  "contractId": 201000000000013,
  "partyId": "61a77df3941da90009fd35db",
  "addressId": "6182ae91c67c61932b38c382",
  "accountId": "6182aeb6c67c61932b38c38b",
  "contractType": "TYPE-A",
  "status": "ACTIVE",
  "startDate": "2021-08-19T15:16:20.630Z",
  "endDate": "2021-12-20T15:16:20.630Z",
  "onContract": true,
  "promotionStacking": true,
  "additionalAttributes": {},
  "isDeleted": false,
  "createdAt": "2021-08-30T23:20:42.822Z",
  "updatedAt": "2021-08-30T23:20:42.822Z",
  "contractPriceList": {
    "_id": "61bcf8f0e30b090008c4cfd5",
    "contractId": "61bcf8f0e30b090008c4cfd2",
    "priceListId": 100000,
    "createdAt": "2021-08-30T23:20:42.822Z",
    "updatedAt": "2021-08-30T23:20:42.822Z"
  }
}

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

​
contractId
string
required

contractId of the contract to delete

Example:

201040000000018

Body

application/json
A sample request to update a contract.
​
partyId
string
required

Fabric internal id for party

Example:

"61a77df3941da90009fd35db"

​
status
enum<string>
required

status

Available options:
ACTIVE,
DRAFT,
INACTIVE
Example:

"ACTIVE"

​
startDate
string
required

start date of the contract. It should be lower that the end date.

Example:

"2021-08-19T15:16:20.630Z"

​
endDate
string
required

end date of the contract. It should be after the start date.

Example:

"2021-12-20T15:16:20.630Z"

​
addressId
string

Fabric internal id for address

Example:

"6182ae91c67c61932b38c382"

​
accountId
string

Fabric internal id for account

Example:

"6182aeb6c67c61932b38c38b"

​
contractType
string

contract type

Example:

"TYPE-A"

​
onContract
boolean

on contract flag. If not sent the default will be false.

Example:

true

​
promotionStacking
boolean

promotion stacking flag. If not sent the default will be false.

Example:

true

​
priceListId
integer

price list id to create a relationship priceList-contract if sent.

Example:

100000

​
additionalAttributes
object

Contains all additional attributes not captured in the schema.

Response

200
application/json
OK
​
_id
string
required

Fabric internal id of the record

Example:

"61604a30fdfacd0009816e44"

​
contractId
string
required

contract id. It must have 2 or more characters.

Example:

201000000000013

​
partyId
string
required

Fabric internal id for party

Example:

"61a77df3941da90009fd35db"

​
status
enum<string>
required

status

Available options:
ACTIVE,
DRAFT,
INACTIVE
Example:

"ACTIVE"

​
startDate
string
required

start date of the contract. It should be lower that the end date.

Example:

"2021-08-19T15:16:20.630Z"

​
endDate
string
required

end date of the contract. It should be after the start date.

Example:

"2021-12-20T15:16:20.630Z"

​
onContract
boolean
required

on contract flag. The default value is false.

Example:

true

​
promotionStacking
boolean
required

promotion stacking flag. The default value is false.

Example:

true

​
isDeleted
boolean
required

flag that indicates if the record is deleted

Example:

false

​
createdAt
string
required

date of creation of the record

Example:

"2021-08-30T23:20:42.822Z"

​
updatedAt
string
required

laste date of update of the record

Example:

"2021-08-30T23:20:42.822Z"

​
addressId
string

Fabric internal id for address

Example:

"6182ae91c67c61932b38c382"

​
accountId
string

Fabric internal id for account

Example:

"6182aeb6c67c61932b38c38b"

​
contractType
string

contract type

Example:

"TYPE-A"

​
additionalAttributes
object

Contains all additional attributes not captured in the schema.

​
contractPriceList
object

this relationship we'll be created only if priceListId was sent in the request body

Was this page helpful?