Installer.com Docs
API ReferenceV1
PATCH
/api/v1/order/{orderId}

Partially update an order. Only fields present in the payload are changed. customFields is keyed by each field's customId; unknown keys are rejected.

Authorization

Bearer
headerAuthorizationBearer <token>

Installer.com auth token

Path Parameters

orderId*string
Formatuuid

Request Body

Order patch payload

application/json
  1. body
name?string
Lengthlength <= 150
description?string

Plain text order description

Lengthlength <= 5000
externalId?|
Lengthlength <= 100
contactPersonName?string
Lengthlength <= 150
email?|
phoneNumber?string
customFields?

Map of custom field customId to its new value, e.g. { "my-field": "some value" }

Response Body

Updated order

application/json
  1. response
id*string
Formatuuid
displayId*string

Job id shown in the app, e.g. P1-123

externalId*|

Your own reference for the order, set on create or PATCH. Not unique.

name*string
description*|

Plain text order description

status*string

Lifecycle of the order: open (PENDING), CANCELLED or DONE. Progress through the workflow is in the workflow field. New values may be added; treat unknown values as opaque.

Value in"PENDING""CANCELLED""DONE"
source*string

How the order was created. New values may be added; treat unknown values as opaque.

Value in"API""MANUAL""FORM""TYPEFORM""WIDGET""WEBFORM"
isTest*boolean

Created to try out a workflow. Left out of List Orders.

contactPersonName*string
email*string
phoneNumber*string
address*string
postalCode*string
city*string
state*string|null
countryCode*string
tags*array<>
customFields*

Custom field values keyed by customId

metadata*|null
workflow?

Read-only progress. Only returned by Get Order.

createdAt*string
Formatdate-time
updatedAt*string

Changes when the order's own fields change. Workflow progress does not change it yet.

Formatdate-time
closedAt*|
Formatdate-time
Example Request
curl -X PATCH 'https://api.installer.com/api/v1/order/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "displayId": "string",  "externalId": "string",  "name": "string",  "description": "string",  "status": "PENDING",  "source": "API",  "isTest": true,  "contactPersonName": "string",  "email": "string",  "phoneNumber": "string",  "address": "string",  "postalCode": "string",  "city": "string",  "state": "string",  "countryCode": "string",  "tags": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "color": "string",      "date": "string"    }  ],  "customFields": {    "property1": "string",    "property2": "string"  },  "metadata": {    "property1": null,    "property2": null  },  "workflow": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",    "templateCustomId": "string",    "templateName": "string",    "templateVersion": 0,    "actors": [      {        "slug": "string",        "name": "string",        "organization": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string",          "externalId": "string"        }      }    ],    "steps": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "templateStepId": "2a465857-77fb-4953-99f7-90a658d82eec",        "title": "string",        "type": "booking_create",        "status": "todo",        "completedAt": "2019-08-24T14:15:22Z",        "actorSlug": "string",        "assignee": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string",          "email": "string"        }      }    ]  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "closedAt": "2019-08-24T14:15:22Z"}

List V1 Partners GET

List partner organizations that can send jobs to your organization (organizations with routing availability to you). Returns each partner organization name, id and external id. Optionally filter by partnershipExternalId to return only the partner you tagged with that id.

Patch Api V1 Product PATCH

Next Page