Skip to content
vocapable.Docs

Hand the accepted delivery to the field-service system (a request, once)

POST
/v1/workspace/handoffs/{handoff_id}/service-jobs
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/handoffs/example/service-jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "installation_id": "example", "client_external_id": "example", "property_external_id": "example", "service_address": { "street1": "example", "street2": "example", "city": "example", "province": "example", "postal_code": "example", "country": "example" }, "preferred_start_note": "example", "reviewed": true }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
handoff_id
required
Handoff Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceServiceJobCreate
object
installation_id
required
Installation Id
string
client_external_id
Any of:
string
<= 200 characters
property_external_id
Any of:
string
<= 200 characters
service_address
Any of:
WorkspaceServiceAddress
object
street1
required
Street1
string
>= 1 characters <= 200 characters
street2
Any of:
string
<= 200 characters
city
required
City
string
>= 1 characters <= 100 characters
province
required
Province
string
>= 1 characters <= 100 characters
postal_code
required
Postal Code
string
>= 1 characters <= 20 characters
country
required
Country
string
>= 2 characters <= 60 characters
preferred_start_note
Any of:
string
<= 300 characters
reviewed
required
Reviewed
boolean
Examplegenerated
{
  "installation_id": "example",
  "client_external_id": "example",
  "property_external_id": "example",
  "service_address": {
    "street1": "example",
    "street2": "example",
    "city": "example",
    "province": "example",
    "postal_code": "example",
    "country": "example"
  },
  "preferred_start_note": "example",
  "reviewed": true
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceServiceJob
object
id
required
Id
string
handoff_id
required
Handoff Id
string
installation_id
required
Installation Id
string
provider
required
Provider
string
Allowed values: jobber servicetitan
status
required
Status
string
Allowed values: queued requested converted scheduled dispatched in_progress completed cancelled dismissed
delivery
required
WorkspaceBusinessDelivery

Where the provider operation behind a record stands (Connection activity has the full history). failed/held records are retried by reconciling first.

object
state
required
State
string
Allowed values: not_started pending succeeded failed uncertain held
error_class
required
Any of:
string
can_retry
required
Can Retry
boolean
external_request_id
required
Any of:
string
external_job_id
required
Any of:
string
job_number
required
Any of:
string
provider_status
required
Any of:
string
visits
required
Visits
Array<object>
WorkspaceServiceVisit

A visit exactly as the provider confirmed it.

object
external_id
required
External Id
string
start_at
required
Any of:
string
end_at
required
Any of:
string
status
required
Any of:
string
assigned
required
Assigned
Array<string>
crew_unconfirmed
required
Crew Unconfirmed
boolean
last_synced_at
required
Any of:
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
Example
{
  "provider": "jobber",
  "status": "queued",
  "delivery": {
    "state": "not_started"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}