updateLeadContacts

Partially update a lead's contacts. Each contact in the input is processed independently: a contact number identifies an existing contact to update, while an omitted, null, or empty contact number creates a contact. For an existing contact, omitted fields retain their existing values. Explicit null or empty values clear scalar fields, including givenName, familyName, email, phoneNumber, landlineNumber, preferredLanguage, and nationalId; null or an empty value for extraDetails clears those details. For contactAddress, omission leaves the address unchanged, null clears it, and an address value replaces it. For roles, omission or null leaves roles unchanged, a non-empty list replaces them, and an empty list is invalid. For consents, omission, null, or an empty list leaves existing consents unchanged; a non-empty list adds or updates the supplied consent types but does not revoke other types. Contacts omitted from the list remain unchanged, and an empty list makes no contact changes.

Arguments

input : UpdateLeadContactsInput!


            required

The lead and per-contact partial updates to apply. This mutation does not delete contacts omitted from the list.

Returns

UpdateLeadContacts

Output type of the updateLeadContacts mutation.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can update leads

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

mutation UpdateLeadContacts($input: UpdateLeadContactsInput!) {
  updateLeadContacts(input: $input) {
    contacts {
      ...LeadContactWriteResultFragment
    }
    leadNumber
  }
}

{
  "input": UpdateLeadContactsInput
}

{
  "data": {
    "updateLeadContacts": {
      "contacts": [LeadContactWriteResult],
      "leadNumber": "study-news-politics-control-yeah"
    }
  }
}