Duplicates

Duplicates Documentation

Duplicate [LIST]

Duplicate [LIST]

Request

Endpoint

GET /api/v2/contacts/duplicates
Content-Type: application/vnd.api+json

Body

Parameters

Filters

account_list_id

Type ID string

Description Filter by Account List; accepts an Account List id

Required No

ignore

Type Boolean

Description Filter by ignored duplicate pairs

Required No

record_ids

Type string (comma delimited IDs)

Description Filter by a comma delimited list of Contact IDs

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "376d18a2-5df3-4e7a-abc4-0bfeb4ee7d27",
      "type": "duplicate_record_pairs",
      "attributes": {
        "created_at": "2021-11-23T14:37:48Z",
        "ignore": false,
        "reason": "Similar names",
        "updated_at": "2021-11-23T14:37:48Z",
        "updated_in_db_at": "2021-11-23T14:37:48Z"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "e94131a5-1301-4284-bf30-81b43af6e5c3",
            "type": "account_lists"
          }
        },
        "records": {
          "data": [
            {
              "id": "7956d177-7f71-4d44-98b9-a5dc4ee55fea",
              "type": "contacts"
            },
            {
              "id": "dd3a2068-fb1d-4942-9458-928679613123",
              "type": "contacts"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Duplicate Record Pair]

Description An array of Duplicate Record Pairs

Duplicate [GET]

Duplicate [GET]

Request

Endpoint

GET /api/v2/contacts/duplicates/6ee642cb-e5f9-4056-98aa-003f3da74433
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "6ee642cb-e5f9-4056-98aa-003f3da74433",
    "type": "duplicate_record_pairs",
    "attributes": {
      "created_at": "2021-11-23T14:37:47Z",
      "ignore": false,
      "reason": "Similar names",
      "updated_at": "2021-11-23T14:37:47Z",
      "updated_in_db_at": "2021-11-23T14:37:47Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "a4c7022d-ffa4-4e0c-941a-6b150d30fea5",
          "type": "account_lists"
        }
      },
      "records": {
        "data": [
          {
            "id": "cc23b82c-92d3-4806-9e77-93ee80cbdb51",
            "type": "contacts"
          },
          {
            "id": "89d9bd3e-7e9a-46c4-9da6-2bac613499bc",
            "type": "contacts"
          }
        ]
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

ignore

Type boolean

Description Whether or not this duplicate pair should be ignored

reason

Type string

Description The reason this duplicate pair was found

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The account list that this Duplicate Record Pair belongs to

records.data

Type [Contact]

Description An array of two Contact references

Duplicate [PUT]

Duplicate [PUT]

Request

Endpoint

PUT /api/v2/contacts/duplicates/7b6d2a3d-37ea-42ca-9d04-b0dadd18a0d4
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "duplicate_record_pairs",
    "attributes": {
      "ignore": true,
      "updated_in_db_at": "2021-11-23 14:37:48 UTC"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "be1f1cc3-2150-4887-9d4b-bb2d6ab31ad7"
        }
      }
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

ignore

Type boolean

Description Whether or not this duplicate pair should be ignored

Required No

overwrite

Type boolean

Description Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.

Required No

reason

Type string

Description The reason this duplicate pair was found

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Relationships

account_list.data

Type Account List

Description The account list that this Duplicate Record Pair belongs to

Required No

records.data

Type [Contact]

Description An array of two Contact references

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "7b6d2a3d-37ea-42ca-9d04-b0dadd18a0d4",
    "type": "duplicate_record_pairs",
    "attributes": {
      "created_at": "2021-11-23T14:37:48Z",
      "ignore": true,
      "reason": "Similar names",
      "updated_at": "2021-11-23T14:37:48Z",
      "updated_in_db_at": "2021-11-23T14:37:48Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "be1f1cc3-2150-4887-9d4b-bb2d6ab31ad7",
          "type": "account_lists"
        }
      },
      "records": {
        "data": [
          {
            "id": "d1074b1a-2c52-4e08-a106-fcd714132083",
            "type": "contacts"
          },
          {
            "id": "48fb4f0a-34da-41e5-96fe-acee35836d7e",
            "type": "contacts"
          }
        ]
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

ignore

Type boolean

Description Whether or not this duplicate pair should be ignored

reason

Type string

Description The reason this duplicate pair was found

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The account list that this Duplicate Record Pair belongs to

records.data

Type [Contact]

Description An array of two Contact references