STstreakyc
Organizations

Create an organization

Changed on

Creates an organization in a team. Available enrichment data may fill missing details. Provide a name or at least one domain. Set custom fields and relationships in a subsequent update.

post/v2/teams/{teamKey}/organizations

Request

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

Path parameters

teamKeystring required

Key of the team.

Query parameters

getIfExistingboolean

Return an existing organization matching a supplied domain instead of creating another organization. The supplied values are not merged into the existing organization.

Request body

namestring nullable

Organization name.

otherstring nullable

Freeform notes about the organization.

domainsstring[] nullable

Website domains for the organization, with the primary domain first.

industrystring nullable

Industry of the organization.

phoneNumbersstring[] nullable

Phone numbers for the organization.

addressesstring[] nullable

Postal addresses for the organization.

employeeCountstring nullable

Company size as text, which can include an employee-count range.

logoURLstring nullable

URL of the organization's logo.

twitterHandlestring nullable

Twitter profile handle or URL.

facebookHandlestring nullable

Facebook profile handle or URL.

linkedinHandlestring nullable

LinkedIn profile handle or URL.

instagramHandlestring nullable

Instagram profile handle or URL.

Response

OK

keystring required

Stable key for this organization.

teamKeystring required

Key for the team that owns this organization.

namestring nullable

Name of the organization.

otherstring nullable

Notes about the organization.

domainsstring[] required

Website domains in their stored order.

normalizedDomainsstring[] required

Stored normalized website domains.

industrystring nullable

Industry of the organization.

phoneNumbersstring[] required

Phone numbers in their stored order.

addressesstring[] required

Postal addresses in their stored order.

employeeCountstring nullable

Employee count or range as text.

logoURLstring nullable

URL of the organization logo.

twitterHandlestring nullable

Twitter profile handle.

facebookHandlestring nullable

Facebook profile handle.

linkedinHandlestring nullable

LinkedIn profile handle.

instagramHandlestring nullable

Instagram profile handle.

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