Skip to main content
PUT
/
api
/
organizations
/
{organizationId}
/
outreach-gross-profit-config
Update outreach gross profit config
curl --request PUT \
  --url https://your-instance.example.com/api/organizations/{organizationId}/outreach-gross-profit-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityType": "Contact",
  "propertyKey": "loanGrossProfit"
}
'
{
  "success": true,
  "data": {
    "entityType": "Contact",
    "propertyKey": "loanGrossProfit"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
organizationId
string
required

Body

application/json

Pass null or {} to clear the config; otherwise must include entityType="Contact" and a non-empty propertyKey.

​
entityType
enum<string>

Entity holding the gross-profit value; currently only Contact is supported.

Available options:
Contact
​
propertyKey
string

Dynamic-property key on the entity whose numeric value is summed for outreach ROI calculation.

Response

Gross profit config updated or cleared

​
success
enum<boolean>
Available options:
true
​
data
object | null
Example:
{
  "entityType": "Contact",
  "propertyKey": "loanGrossProfit"
}