Contacts

Update multiple contacts

Update multiple contacts in a single request. Each contact in the request body must include its ID along with the fields to update.

PUT /v1/contacts/

Request body

Content-Type: application/json

[].contactId

string (uuid) required

[].data

object required

[].data.full_name

string

[].data.first_name

string

[].data.last_name

string

[].data.description

string

[].data.job_title

string

[].data.legacy_location

string

[].data.company

string

[].data.education

string

[].data.starred

boolean

[].data.source

string enum

Possible values: "linkedin_sync", "facebook_import", "cal_ingest", "email_ingest", "web_import", "csv_import", "whatsapp_sync", "imessage_sync", "phone_calls_sync", "mobile", "mobile_import", "instagram_sync", "oauth_interaction"

[].data.coordinates

object

[].data.coordinates.operation

string enum

Possible values: "set", "delete"

[].data.coordinates.data

object

[].data.coordinates.data.latitude

number

[].data.coordinates.data.longitude

number

[].data.priority_tier

integer

[].data.image_url

string (uri)

[].data.image_source

string (uri)

[].data.business_card_url

string (uri)

[].data.website

any

[].data.birthday

string (date)

[].data.birthday_year

number

[].data.frequency

string

[].data.last_seen_at

any

[].data.first_met_at

any

[].data.never_keep_in_touch

boolean

[].data.next_reminder_at

any

[].data.linkedin

string

[].data.twitter

string

[].data.facebook

string

[].data.instagram

string

[].data.telegram

string

[].data.tiktok

string

[].data.youtube

string

[].data.whatsapp_message_link

string

[].data.whatsapp_message_snippet

string

[].data.whatsapp_last_message_at

any

[].data.imessage_message_link

string

[].data.imessage_message_snippet

string

[].data.imessage_last_message_at

any

[].data.linkedin_message_link

string

[].data.linkedin_last_message_snippet

string

[].data.linkedin_last_message_at

any

[].data.linkedin_data

object

[].data.instagram_message_link

string

[].data.instagram_message_snippet

string

[].data.instagram_last_message_at

any

[].data.gmail_last_interaction_at

any

[].data.gmail_last_interaction_provider_id

string

[].data.gmail_last_interaction_subject

string

[].data.gmail_last_interaction_provider

string enum

Possible values: "GOOGLE", "OFFICE365"

[].data.gcal_last_interaction_at

any

[].data.gcal_last_interaction_provider_id

string

[].data.gcal_last_interaction_title

string

[].data.gcal_last_interaction_provider

string enum

Possible values: "GOOGLE", "OFFICE365"

[].data.phone_call_last_interaction_at

any

[].data.phone_call_interaction_snippet

string

[].data.web_search_summary

object

[].data.legacy_contact_addresses

array<object>

[].data.legacy_contact_addresses[].formatted

string

[].data.contact_emails

array<object>

[].data.contact_emails[].email

string

[].data.contact_emails[].label

string

[].data.contact_emails[].ranking

number

[].data.contact_phone_numbers

array<object>

[].data.contact_phone_numbers[].phone_number

string

[].data.contact_phone_numbers[].country_code

string

[].data.contact_phone_numbers[].phone_number_sanitized

string

[].data.contact_phone_numbers[].label

string

[].data.contact_phone_numbers[].ranking

number

[].data.groups_contacts

array<object>

[].data.groups_contacts[].group_id

string (uuid)

[].data.tags_contacts

object

[].data.tags_contacts.append

array<object>

[].data.tags_contacts.append[].tag_id

string (uuid)

[].data.tags_contacts.remove

array<object>

[].data.tags_contacts.remove[].tag_id

string (uuid)

[].data.tags_contacts.remove[].contact_id

string (uuid)

[].data.tags_contacts.replace

any

[].data.custom_fields

array<object>

[].data.custom_fields[].id

string (uuid)

[].data.custom_fields[].type

string enum

Possible values: "input"

[].data.custom_fields[].text_value

string

[].data.custom_fields[].custom_field

any

[].data.contact_birthdays

object

[].data.contact_birthdays.contact_id

string (uuid)

[].data.contact_birthdays.last_dismissal_year

number

[].data.is_archived

boolean

[].data.ignore_merge

boolean

[].data.related_contacts

object

[].data.related_contacts.append

array<object>

[].data.related_contacts.append[].destination

string (uuid)

[].data.related_contacts.append[].source_contact

any

[].data.related_contacts.append[].destination_contact

any

[].data.related_contacts.remove

array<object>

[].data.related_contacts.remove[].source

string (uuid)

[].data.related_contacts.remove[].destination

any

[].data.related_contacts.replace

any

Example

[
  {
    "contactId": "00000000-0000-0000-0000-000000000000",
    "data": {
      "full_name": "string",
      "first_name": "string"
    }
  }
]

Responses

200 — Successful response

Content-Type: application/json

error

boolean required

data

object required

data.count

integer required

Example

{
  "error": false,
  "data": {
    "count": 0
  }
}

400

No response body.

401

No response body.

403

No response body.

404

No response body.

429

No response body.

500

No response body.

Code samples

curl https://api.prod.getdex.com/v1/contacts/ \
  --request PUT \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "contactId": "00000000-0000-0000-0000-000000000000",
    "data": {
      "full_name": "string",
      "first_name": "string"
    }
  }
]'

fetch('https://api.prod.getdex.com/v1/contacts/', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    0: {
      contactId: '00000000-0000-0000-0000-000000000000',
      data: {
        full_name: 'string',
        first_name: 'string'
      }
    }
  })
})

requests.put("https://api.prod.getdex.com/v1/contacts/",
    headers={
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    json=[
      {
        "contactId": "00000000-0000-0000-0000-000000000000",
        "data": {
          "full_name": "string",
          "first_name": "string"
        }
      }
    ]
)

Create contacts

Create one or more new contacts for the authenticated user. Accepts an array of contact objects with fields like name, email, phone, company, and job title.

Delete multiple contacts

Delete multiple contacts in a single request by providing an array of contact IDs. This permanently removes the contacts and their associated data.