Installer.com Docs
API ReferenceV1
POST
/api/v1/webform-order/{webformId}

Authorization

Bearer
headerAuthorizationBearer <token>

Installer.com auth token

Path Parameters

webformId*string
Formatuuid

Query Parameters

partnershipId?string

Request Body

Create webform order

application/json
  1. body
name?|
Lengthlength <= 150
description?||null
metadata?|null
actorAssignments?array<>
partnershipId?string|null
workflowCustomId?string|null
idempotencyKey?|

A unique optional identifier for the order. If the same idempotency key is used for multiple requests, the order will be created only once. Any string up to 150 characters is allowed. If not provided check for existing order with the same idempotency key will not be performed. Ideally use a UUID.

Length1 <= length <= 150
files?array<>|null
orderTagIds?array<>|null
customFields?array<>|null
offer?
isTest?|

Marks the order as a test order, e.g. created to try out a workflow template.

email*string
Formatemail
phoneNumber*string
contactPersonName*string
Length1 <= length <= 150
customerLegalId?|
Length1 <= length <= 50
externalId?|

The caller's own reference for this order in an external system (e.g. an accounting project reference). Free-form, up to 100 characters.

Lengthlength <= 100
property?||null
address*string
Lengthlength <= 250
city*string
Lengthlength <= 150
postalCode*string
Lengthlength <= 50
state?|
Lengthlength <= 16
countryCode*string
latitude?number|null
longitude?number|null

Response Body

Creates webform order

application/json
  1. response
id*string
Formatuuid
token*string
clientUrl*string
Formaturi
Example Request
curl -X POST 'https://api.installer.com/api/v1/webform-order/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "email": "[email protected]",  "phoneNumber": "string",  "contactPersonName": "string",  "address": "string",  "city": "string",  "postalCode": "string",  "countryCode": "string"}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "token": "string",  "clientUrl": "http://example.com"}

Create Api V1 Product POST

Previous Page

Create V1 Unclaimed Partner Organization POST

Creates a new partner organization with a name and a partnershipExternalId (your own id for the partner, used to refer to it in your systems), and immediately sets up an active partnership and routing availability so the new organization can send jobs to your organization (it will then appear in GET /v1/partners). ONLY use this endpoint if you know the partner is not already on the platform — creating a duplicate organization for a partner that already exists will fragment their data. Use GET /v1/partners first to check whether the partner already exists.