Create Organization

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Create a new Organization tied to the Partner (based on the API Key used).

The response includes an API key for the newly created organization, which can be used immediately to authenticate against the Organization API.

Request Body

NameTypeRequiredDescription
namestringYesOrganization name (must be unique within the partner, case-insensitive)
admin_contact_emailstringYesAdmin contact email address
admin_contact_namestringYesAdmin contact full name
finance_contact_emailstringNoFinance contact email address (defaults to admin_contact_email)
finance_contact_namestringNoFinance contact full name (defaults to admin_contact_name)

Returned Data

NameTypeDescription
idstringUnique Organization ID
namestringOrganization display name
created_atdatetimeCreation timestamp (ISO 8601)
api_keystringOrganization API key for authenticating against the Organization API
Body Params
string
required

Organization name (must be unique within the partner, case-insensitive)

string
required

Admin contact email address

string
required

Admin contact full name

string

Finance contact email address (defaults to admin_contact_email)

string

Finance contact full name (defaults to admin_contact_name)

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json