Create a contact

post

https://api.streak.com/api/v2/teams/{teamKey}/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Content Type and Auth
Make sure to include -H "Content-Type: application/json" and your authorization in any request you make on your own.

Error	Example	Details
Missing parameters	`{ "error": "Insufficient params for TeamContact", "success": false }`	You might be missing the teamKey, emailAddresses, givenName, or familyName
Incorrect teamKey, API path has something mis-spelled or missing	`{ "success": false }` OR `{ "error": "Invalid API path specified", "success": false }`	We can't find the teamKey you've provided.
Need more information on the contact	`"Need to specify at least a name or email address"`	We require one of the following to create a contact: `givenName` `familyName` `emailAddresses`
Need appropriate header	`{ "error": "Missing parameters", "success": false }`	If you do not have the header `-H "Content-Type: application/json"` your call will return this error.
Duplicate email addresses	`{ "error": "Contacts can't have duplicate emails: [email protected]", "errorCode": 801, "success": false }`	You can not pass duplicate email addresses, ie `["[email protected]", "[email protected]"]`

❗️
Check if contact exists?
If the getIfExisting parameter is included, you can ONLY pass the parameter of emailAddresses.

Path Params

teamKey

string

required

Team key

Query Params

getIfExisting

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

givenName

string

First name

familyName

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*

title

string

Contact's title/description

other

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

twitterHandle

string

facebookHandle

string

linkedinHandle

string

photoUrl

string

Responses

Content Type and Auth

Check if contact exists?

200200

400400