PATCH api/v1/Contacts

Will PATCH the given {Fields} on contacts by the given {Keys}.

Request Information

URI Parameters

None.

Body Parameters

PatchContactsDto
NameDescriptionTypeAdditional information
KeyType

Indicates type of {Keys}

UpdateContactKeyType

None.

Keys

Indicates contact field values for a PATCH

Collection of string

None.

Fields

Indicates contact field names and values for a PATCH

Dictionary of string [key] and Object [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "KeyType": "Id",
  "Keys": [
    "sample string 1",
    "sample string 2"
  ],
  "Fields": {
    "sample string 1": {},
    "sample string 3": {}
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatchContactsResultDto
NameDescriptionTypeAdditional information
Updated

Indicates which given {Keys} were found and PATCHed with given {Fields}

Collection of string

None.

NotFound

Indicates which given {Keys} were not found

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Updated": [
    "sample string 1",
    "sample string 2"
  ],
  "NotFound": [
    "sample string 1",
    "sample string 2"
  ]
}