Create client account API (Agency plan only)
Create client account API (Agency plan only)
Create client account API
This API endpoint will enable subscribers to the Agency Plan to create client sub-accounts and define the number of seats allocation.
This API endpoint is intended to be used to automate the creation of client accounts for Agencies and White labels.
Base API URL:
https://app.hyperise.io/api/v1/regular/organizations?api_token=<your_token>
To use the API, you must first create an API token in the Settings area and use this token with all api requests.
Input:
Label | Key | Type | Required |
API Token | api_token | String | Yes |
Organization name | name | String | Yes |
String | Yes | ||
Number of Seats | seats | Number | Yes |
The API will provide a JSON output.
Sample of business object Output
{
"id": 4845,
"name": "Client ABC",
"created_at": "2021-06-29 11:32:17"
}
Example input / output
The API call will then trigger an invite email:
If using the White Label, the email used and the platform name are set via the White Label settings.
Discover other Hyperise APIs:
User Authentication - Authorise the API token.
List Image Templates - List all active Image templates for the authorised user.
Image Views - List the most recent personalised views for selected image.
Business Data - Add/Update/View prospect data for images to use.
Short Links - Create personalised Short Links.
Did this answer your question?