HomeAPI Reference
API Reference

Create a contact

post
https://api.streak.com/api/v2/teams//contacts/

Create a new contact. All contacts are scoped to a particular team so a teamKey is required. When creating a contact you can provide all of the contact info in a single call. See the possible parameters below.

Contacts must have at least one of name or emailaddresses set.

Note: Including the parameter getIfExisting limits the parameters you can include in the call.

Path Params
string
required

Team key

Query Params
boolean

If set to true, will check for existing contact based on email. If contact does exist, call will return existing contact; else, call will create new contact. Either way, the call will return a contact. If you include this parameter, the call can only take a teamKey and a contact's emailAddresses. If you have more information on your contact, you'll need to run a separate call to update it. See Update a contact.

Body Params
string

First name

string

Last name

emailAddresses
array of strings
required

The only email addresses associated with the contact will be the ones you include here; make sure to include any previously associated addresses as well as the new one(s).

emailAddresses*
string

Contact's title/description

string

Notes or other uncategorized information.

addresses
array of strings

The only addresses associated with the contact will be the ones you include here; make sure to include any previously associated addresses as well as the new one(s).

addresses
phoneNumbers
array of strings

The only phone numbers associated with the contact will be the ones you include here; make sure to include any previously associated numbers as well as the new one(s).

phoneNumbers
string
string
string
string
Responses

Updated 10 months ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 10 months ago