Skip to content

Remove relationship between record and Entity

DELETE https://api.prosperworks.com/developer_api/v1/{{entity}}/{{entity_id}}/related

Removing the relationship does not cause any of the records involved to be deleted from the system.

Request body

1
2
3
4
5
6
{
  "resource": {
    "id": 2827700,
    "type": "opportunity"
  }
}

Example Requests

Remove relationship between person and opportunity

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
curl --location --request DELETE "https://api.prosperworks.com/developer_api/v1/people/{{example_person_id}}/related" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data "{
    \"resource\": {
        \"id\": 2827700,
        \"type\": \"opportunity\"
    }
}"
1
2
3
4
5
6
7
{
  "removed": true,
  "resource": {
    "id": 2827700,
    "type": "opportunity"
  }
}