PApaymongo
Contacts

Check contacts

Check which of the given emails and phones are already attached to existing contacts. Returns per-value in_use flags with the owning contact_id.

post/v1/contacts/check

Request

  • Base URL
    https://contacts-api.paymongo.com
  • URL
    https://contacts-api.paymongo.com/v1/contacts/check
  • Auth
    HTTP basic

Request body

emailsstring[]
phonesstring[]

Example request

{
  "emails": [
    "juan@example.com"
  ],
  "phones": [
    "+639171234567"
  ]
}

Response

OK

Example response

{
  "data": {
    "emails": [
      {
        "contact_id": "cnt_0123456789abcdef01234567",
        "in_use": true,
        "value": "juan@example.com"
      }
    ],
    "phones": [
      {
        "contact_id": "cnt_0123456789abcdef01234567",
        "in_use": true,
        "value": "juan@example.com"
      }
    ]
  },
  "errors": [
    {
      "detail": "Explanation of error code for this case",
      "source": {
        "header": "X-Header-Name",
        "parameter": "field_name",
        "pointer": "/data/customers/0/attributes/name"
      }
    }
  ],
  "meta": {
    "requested": 2,
    "resolved": 2
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.