Update an organization

PATCH

/organizations/{oid}

curl --request PATCH \
  --url https://apisandbox.puurk.com/organizations/example \
  --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

Update an existing organization

Authorizations

• service_token

Parameters

Path Parameters

oid

required

string

Organization ID

Request Body^required

Request body

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 updated

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

bad_request — invalid body; type is not client or test (Invalid type. Must be one of: client, test); name is blank; or subscription_level is not a supported value.

Media typeapplication/json

The standard error body. error is a stable, machine-readable code — branch on it rather than on message, which is for humans and may change.

object

error

Machine-readable error code.

string

message

Human-readable detail.

string

Example

{
  "error": "merchant_account_missing",
  "message": "The organization has no merchant account. Complete Stripe Connect onboarding for this organization before generating pricing."
}

401

Unauthorized

404

Not found