STstreakyc
Contacts

Create contact

Changed on

Creates a contact from its basic details. Links and custom fields require a subsequent update.

post/v2/teams/{teamKey}/contacts

Request

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

Path parameters

teamKeystring required

Key of the team.

Query parameters

getIfExistingboolean nullable

Return an existing email match instead of creating a contact. When getIfExisting=true, an email match is returned without merging new values.

Request body

givenNamestring nullable

Given name.

familyNamestring nullable

Family name.

titlestring nullable

Job title.

otherstring nullable

Additional notes about the contact.

emailAddressesstring[] nullable

Email addresses for the contact.

phoneNumbersstring[] nullable

Phone numbers for the contact.

addressesstring[] nullable

Postal addresses for the contact.

domainsstring[] nullable

Website domains associated with the contact.

twitterHandlestring nullable

Twitter handle.

facebookHandlestring nullable

Facebook handle.

linkedinHandlestring nullable

LinkedIn handle.

instagramHandlestring nullable

Instagram handle.

photoUrlstring nullable

URL for the contact's photo.

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