Create an Organization

post https://api.streak.com/api/v2/teams/{key}/organizations

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

Organizations must have at least one of name or domains set.

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

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.

You must include a name OR a website (domains) in your request, or your organization will fail to create.
You may not have duplicated websites.
You must have permissions to create an organization for the team or you will not be able to complete this request.

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

Path Params

key

string

required

Team key

Query Params

getIfExisting

boolean

If set to true, will check for existing organization based on website(s). Including the getIfExisting parameter will return an organization with a matching website if it exists, otherwise it will create the organization. Either way, the call will return an organization. This particular call can only take a teamKey and a organization's domains. If you have more information on your organization, you'll need to run a separate call to update it.

Body Params

name

string

required

Organization name

domains

array of strings

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

domains

industry

string

Organization industry

phoneNumbers

array of strings

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

phoneNumbers

addresses

array of strings

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

addresses

employeeCount

int32

Employee count at the organization

logoURL

string

URL of the organization's logo

other

string

Notes or other uncategorized information.

twitterHandle

string

facebookHandle

string

linkedinHandle

string

Responses

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.streak.com/api/v2/teams/key/organizations \
3
     --header 'Content-Type: application/json' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Create an Organization

🚧
Content Type and Auth

❗️
Check if organization exists?

🚧Content Type and Auth

❗️Check if organization exists?

200200

400400

🚧
Content Type and Auth

❗️
Check if organization exists?