PATCHing ClaimContacts

Use the following endpoint to PATCH a ClaimContact:

  • PATCH /claim/v1/claims/{claimId}/contacts/{contactId}

For example, the following request updates the contactProhibited field for contact xc:55 on claim xc:404 to trueon claim xc:404:

Command

PATCH /claims/xc:404/contacts/xc:55

Request body

{
  "data": {
    "attributes": {
      "contactProhibited": true
    }
  }
}

This request hides a contact's information from being viewed, protecting the contact's privacy. The contactProhibited field is set to false by default.

You can also use the PATCH /claims/{claimId}/contacts/{contactId} endpoint to modify a contact's non-reserved roles. For more information, see Assigning roles to existing ClaimContacts.