Account Information
These endpoints are primarily used for administrative configuration and branding, allowing you to customize how your account is represented across applications and user interfaces.
UpdateInfo
Update information used to describe your account:
1. Company name
2. Display name
3. Descriptive text
4. Integration notes
5. Service category
Parameters may be updated individually or in any combination.
Request
All parameters are optional, but at least one must be provided to execute an update.
curl -L -X POST 'https://{DOMAIN}/voyorequest/UpdateInfo
-d 'company={COMPANY}&name={NAME}&description={DESCRIPTION}&integration={INTEGRATION}&category={CATEGORY}'
-H 'Accept: application/json'
-H 'Authorization: Bearer {APIKEY}'
| Parameter | Description | Max Size |
|---|---|---|
company |
Name of the company this account belongs to. | 250 |
name |
Name of this account. | 250 |
description |
Description of what this account is used for. | 65535 |
integration |
Description of how this account is integrated with your company. | 65535 |
category |
The category of service this account falls under. | 50 |
Error Responses
HTTP/1.1 400 Bad Request
// Must provide at least one parameter
{"error":"Requires something to update!"}
Success Responses
Account information was updated successfully.
{"error":"Success!"}
UploadIcon
Upload an image that will service as your account avatar.
This endpoint accepts .jpg, .jpeg, .webp, or .png formats, and enforces size and type restrictions.
Request
curl -L -X POST 'https://{DOMAIN}/voyorequest/UploadIcon
-d 'icon={ICON}'
-H 'Authorization: Bearer {APIKEY}'
| Parameter | Description |
|---|---|
icon |
Image file to upload; must be .jpg, .jpeg, .webp, or .png format. |
Error Responses
HTTP/1.1 400 Bad Request
// Image must be less than 1 mb
{"error":"File is too large!"}
// Improper file format provided
{"error":"Requires image to be 'jpeg', 'png, or 'webp' format!"}
// Image failed sanity check
{"error":"Requires a valid image file!"}
// "icon" not included in post request
{"error":"Requires 'icon' to be uploaded!"}
Success Responses
The provided icon was uploaded successfully.
{"error":"Success!"}