GuidesAPI ReferenceDiscussions
API Reference

Deploy an add-on (atomic manifest + function upsert)

put
https://api.servicem8.com/api_1.0/addonsdk/addon/.json
🚧

Private Preview

The Addon SDK API is currently in private preview. These endpoints are only available to accounts and Add-ons enrolled in the preview program — you may not have access yet.

Creates the add-on on first deploy (private/unlisted) and updates it thereafter. One multipart request carries the manifest JSON part and the bundled function source part. The manifest is validated before anything is committed. Returns 202 with a deployment id to poll. Requires a full-access API key.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[a-z0-9]([a-z0-9-]{0,62}[a-z0-9])?$

The add-on's unique slug (per-account; lowercase letters, digits, hyphens)

Body Params
string
required

The add-on manifest as a JSON object (max 64KB)

file
required

The bundled Simple Function JavaScript (CJS, exports.handler; max 45MB)

Responses

Updated 22 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago

Did this page help you?