STstreakyc
Contacts

Update contact

Changed on

Applies supplied changes. Null or omitted fields remain unchanged.

post/v2/contacts/{contactKey}

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v2/contacts/{contactKey}
  • Auth
    HTTP bearer

Path parameters

contactKeystring required

Key of the contact.

Request body

givenNamestring nullable

New given name; an empty string clears it if another identifier remains.

familyNamestring nullable

New family name; an empty string clears it if another identifier remains.

titlestring nullable

New job title; an empty string clears it.

otherstring nullable

New notes; an empty string clears them.

emailAddressesstring[] nullable

Replacement email addresses; a contact must retain an email address or a name.

phoneNumbersstring[] nullable

Replacement phone numbers. Empty entries are removed.

addressesstring[] nullable

Replacement postal addresses. Empty entries are removed.

domainsstring[] nullable

Replacement website domains.

twitterHandlestring nullable

Replacement Twitter handle.

facebookHandlestring nullable

Replacement Facebook handle.

linkedinHandlestring nullable

Replacement LinkedIn handle.

instagramHandlestring nullable

Replacement Instagram handle.

photoUrlstring nullable

Replacement photo URL.

fieldsobject nullable

Custom-field values to merge by field key. Null entries are ignored; an empty map leaves existing fields unchanged.

Example request

{
  "contactLinks": [
    {
      "creationTimestamp": 1646870400000
    }
  ],
  "orgLinks": [
    {
      "creationTimestamp": 1646870400000
    }
  ]
}

Response

OK

keystring required

Stable key for this contact.

teamKeystring required

Key for the team that owns this contact.

givenNamestring nullable

Given name of the contact.

familyNamestring nullable

Family name of the contact.

otherstring nullable

Notes about the contact.

titlestring nullable

Job title of the contact.

emailAddressesstring[] required

Normalized email addresses with duplicates removed, in first-occurrence order.

phoneNumbersstring[] required

Phone numbers with duplicates and null entries removed, in first-occurrence order.

addressesstring[] required

Postal addresses with duplicates and null entries removed, in first-occurrence order.

domainsstring[] required

Website domains associated with the contact.

normalizedDomainsstring[] required

Stored normalized domains used to match organizations.

twitterHandlestring nullable

Twitter profile handle.

facebookHandlestring nullable

Facebook profile handle.

linkedinHandlestring nullable

LinkedIn profile handle.

instagramHandlestring nullable

Instagram profile handle.

photoUrlstring nullable

URL of the contact profile image.

lastSavedUserKeystring nullable

Key for the user who last edited this record.

creatorKeystring nullable

Key for the user who created this record.

creationDateinteger nullable

Time this record was first created, in epoch milliseconds.

versionTimestampinteger nullable

Time this version of the record was created, in epoch milliseconds.

lastSavedTimestampinteger nullable

Time this record was last saved, in epoch milliseconds.

lastEnrichmentTimestampinteger nullable

Time enrichment was last applied or reviewed, in epoch milliseconds.

fieldsobject required

Custom field values keyed by field identifier.

Example response

{
  "creationDate": 1646870400000,
  "versionTimestamp": 1646870400000,
  "lastSavedTimestamp": 1646870400000,
  "lastEnrichmentTimestamp": 1646870400000,
  "contactLinks": [
    {
      "creationTimestamp": 1646870400000
    }
  ],
  "orgLinks": [
    {
      "creationTimestamp": 1646870400000
    }
  ]
}

Changes