STstreakyc
Organizations

Update an organization

Changed on

Updates an organization. Omitted and null properties are unchanged. Supplied lists replace existing lists, subject to field validation.

post/v2/organizations/{organizationKey}

Request

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

Path parameters

organizationKeystring required

Key of the organization.

Request body

namestring nullable

Replacement organization name. A name or domain must remain after the update.

otherstring nullable

Replacement notes. An empty string clears the notes.

domainsstring[] nullable

Replacement domains, with the primary domain first. An empty list clears domains if a name remains.

industrystring nullable

Replacement industry.

phoneNumbersstring[] nullable

Replacement phone numbers. An empty list clears existing phone numbers.

addressesstring[] nullable

Replacement postal addresses. An empty list clears existing addresses.

employeeCountstring nullable

Replacement company size as text, including employee-count ranges.

logoURLstring nullable

Replacement organization logo URL.

twitterHandlestring nullable

Replacement Twitter profile handle or URL.

facebookHandlestring nullable

Replacement Facebook profile handle or URL.

linkedinHandlestring nullable

Replacement LinkedIn profile handle or URL.

instagramHandlestring nullable

Replacement Instagram profile handle or URL.

fieldsobject nullable

Custom field values to change, keyed by field ID. Omitted keys and null values are unchanged; an empty object makes no changes.

Example request

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

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