Locations

Upload Location Image

Use this endpoint to Upload an image to a location object. A valid business location id is required. You must convert the image to a base64 encoded string and pass that string as input along with your filename.

post/setup/v1/locations/{id}/uploadimage

Request

Base URL
https://sandbox-api.onsched.com
Auth
OAuth 2
Client credentials
Token URLhttps://sandbox-identity.onsched.com/connect/token
ScopesOnSchedApi
TypeScript
https://skmtc.dev/onsched/apis/onsched-setup-api/docs/setup/v1/locations/:id/uploadimage/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

id of business location, defaults to primary business location

Request body

imageFileNamestring nullable

imageFileDatastring nullable

Response

Success

objectstring nullable

idstring nullable

friendlyIdstring nullable

companyIdstring nullable

companyNamestring nullable

namestring nullable

adminEmailstring nullable

adminNamestring nullable

phonestring nullable

faxstring nullable

emailstring nullable

websitestring nullable

regionIdstring nullable

logostring nullable

imageUrlstring nullable

timezoneIdstring nullable

timezoneIanastring nullable

timezoneOffsetinteger nullable

primaryBusinessboolean

primaryCalendarIdstring nullable

latitudenumber double

longitudenumber double

Changes

No recorded changes to this operation across all 1 revision of this API.