Link and Unlink a deal with contacts and companies

patch/crm/deals/link-unlink/{id}

Request

Base URL
https://api.brevo.com/v3
Auth
- API key in header api-key
- or API key in header partner-key
TypeScript
https://skmtc.dev/getbrevo/apis/brevo-api/docs/crm/deals/link-unlink/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Request body

linkContactIdsinteger[]

Contact ids for contacts to be linked with deal

unlinkContactIdsinteger[]

Contact ids for contacts to be unlinked from deal

linkCompanyIdsstring[]

Company ids to be linked with deal

unlinkCompanyIdsstring[]

Company ids to be unlinked from deal

Example request

{
  "linkContactIds": [
    1,
    2,
    3
  ],
  "unlinkContactIds": [
    4,
    5,
    6
  ],
  "linkCompanyIds": [
    "61a5ce58c5d4795761045990",
    "61a5ce58c5d4795761045991",
    "61a5ce58c5d4795761045992"
  ],
  "unlinkCompanyIds": [
    "61a5ce58c5d4795761045994",
    "61a5ce58c5d479576104595",
    "61a5ce58c5d4795761045996"
  ]
}

Response

Successfully linked/unlinked contacts/companies with the deal.

Changes

No recorded changes to this operation across all 2 revisions of this API.