Organizations
Create & Update Organizations
Create Organization
You should only create an organization via API key if you are an enterprise customer looking to create a multi-organization setup. Please note there can be significant costs associated with this setup, so please reach out to your account manager if you are interested in this.
Creates a new organization in the PackageX platform. This endpoint serves two distinct purposes:
- Creating tenant organizations (when called with an API key)
- Creating standalone organizations
Enterprise Tenant Creation
When using an API key, this endpoint creates a tenant organization managed by your enterprise organization. Your organization must be on an enterprise plan to create tenants. Each tenant organization maintains separate data but billing is handled through the parent organization.
Request Body
Organization Setup
The endpoint configures:
- Organization settings (deliveries, shipments, notifications, etc.)
- Billing configuration
- User roles (Owner and User with predefined permissions)
- Initial wallet
- Organization logo (auto-generated)
- Base location (for tenant organizations)
Role Configuration
Two default roles are created:
- Owner Role:
- Full system access
- Cannot be removed
- Manages organization settings
- User Role:
- Limited permissions
- Customizable access levels
- Standard operational capabilities
Example Request
Update Organization and it's settings
OR
When updating an organization, you can either user the full organization ID in proper RESTful fashion, or you can use the org
shortcut since your API key is scoped to the organization anyway.
Besides billing, every other property for the organization can be updated in the same structure as the model.
Any properties that have deeply nested lists with objects inside of them including settings.deliveries.rate_classes
, settings.deliveries.private_rates
, and settings.fulfillments.predefined_packages
, have their own RESTful endpoints to make creating, updating, and deleting them easier.
Example Request
Create / Update roles
Creates a new role or updates an existing role within your organization. This endpoint provides comprehensive control over role configurations, permissions.
OR
Request Body Structure
Example Requests
- Creating a New Role:
- Updating an Existing Role:
Update Payout Profile
Updates an organization's payout profile.
OR
Request Body Structure
Example Request
Update External Payout Account
Updates or adds a bank account for receiving payouts through Stripe.
OR
Request Body Structure
Example Request
Update Organization Logo
Updates an organization's logo.
OR
Request Body Structure
Example Request
Create/Update Delivery Rate
This endpoint manages delivery rate configurations for organizations, enabling the creation of new rates and modification of existing ones
OR
Request Body Structure
The endpoint accepts a comprehensive rate configuration object:
Example Requests
- Creating a New Rate:
- Updating an Existing Rate:
Create/Update Delivery Rate Package
This endpoint manages package configurations associated with delivery rates, enabling organizations to define specific package dimensions, and weights for each delivery rate.
OR
Request Body Structure
Example Requests
- Creating a New Package Configuration:
- Updating an Existing Package:
Create/Update Predefined Package
This endpoint manages predefined package configurations for organizations, enabling the creation and modification of standardized package templates.
OR
Request Body Structure
Example Requests
- Creating a Custom Package:
- Using a Provider Package Template:
Update Shipment Provider
This endpoint manages shipment provider configurations for organizations.
OR
Request Body Structure
The endpoint accepts provider configuration updates in two formats for flexibility:
- Standard Format:
- Alternative Format (Nested Structure):
Example Requests
- Activating a Provider:
- Deactivating a Provider:
Create Organization Notification Rules
This endpoint enables organizations to establish and manage notification rules, controlling how and when notifications are triggered within their organization
OR
Request Body Structure
Example Request
Create Organization Domain
This endpoint enables organizations to establish and manage domain configurations for their login settings.
OR
Request Body Structure
Example Request
Updating Organization Domain
This endpoint allows organizations to modify existing domain configurations within their login settings.
OR
Request Body Structure
Example Request
Create Organization SSO Configuration
This endpoint enables organizations to establish Single Sign-On (SSO) configurations for their verified domains.
OR
Request Structure
The endpoint accepts two distinct configuration formats based on the authentication protocol:
- For OpenID Connect (OIDC):
- For SAML:
Example Request
Update Organization SSO Configuration
This endpoint enables organizations to modify existing Single Sign-On (SSO) configurations.
OR
Request Structure
The endpoint accepts protocol-specific update configurations:
- For OpenID Connect (OIDC):
- For SAML:
Example Request
Apply Organization Login Settings
This endpoint enables organizations to enforce their login domain preferences.
OR
Request Structure
Example Usage
- Testing Domain Policy:
- Applying Domain Policy: