Create an organization

POST

/organizations

curl --request POST \
  --url https://apisandbox.puurk.com/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "example", "eid": "example", "name": "example", "ein": "example", "logo_path": "example", "type": "client", "roles": { "additionalProperty": "owner" }, "settings": { "additionalProperty": true }, "features": { "additionalProperty": true } }'

• Sandbox
• Production

Create a new organization

Authorizations

• service_token

Request Body^required

Organization to create

Media typeapplication/json

object

id

Unique identifier for the organization

string

eid

External identifier for the organization

string

name

Name of the organization

string

ein

Employer Identification Number

string

logo_path

Path to the organization’s logo

string

type

Type of organization. Validated on create and update; any other value is rejected with 400 Invalid type. Must be one of: client, test.

string

Allowed values: client test

roles

User roles in the organization

object

key

additional properties

Role of a user in an organization, as stored in the organization’s roles map. admin is not a role: it is a service-token scope action, and a request that sends it as a role gets 400. Of the organization roles, only owner and agencyadmin may change other members’ roles.

string

Allowed values: owner manager read write provider accountant officeadmin agencyadmin agencyuser none

settings

Organization settings

object

key

additional properties

boolean

features

Puurk features enabled for the organization

object

key

additional properties

boolean

Responses

200

Organization created

Media typeapplication/json

object

id

Unique identifier for the organization

string

eid

External identifier for the organization

string

name

Name of the organization

string

ein

Employer Identification Number

string

logo_path

Path to the organization’s logo

string

type

Type of organization. Validated on create and update; any other value is rejected with 400 Invalid type. Must be one of: client, test.

string

Allowed values: client test

roles

User roles in the organization

object

key

additional properties

Role of a user in an organization, as stored in the organization’s roles map. admin is not a role: it is a service-token scope action, and a request that sends it as a role gets 400. Of the organization roles, only owner and agencyadmin may change other members’ roles.

string

Allowed values: owner manager read write provider accountant officeadmin agencyadmin agencyuser none

settings

Organization settings

object

key

additional properties

boolean

features

Puurk features enabled for the organization

object

key

additional properties

boolean

Example

{
  "type": "client",
  "roles": {
    "additionalProperty": "owner"
  }
}

400

Invalid input

401

Unauthorized