site

Update a site

Update mutable fields on a site for the partner the API key belongs to. The public site contract maps onto the internal Address-backed update flow. Only the fields you include in the request body are modified; omitted fields are left as-is. platformSlaId cannot be updated while an address subscription is associated. customProperties accepts the custom properties defined for your partner, keyed by property id; send null to clear one. Requires the site:write scope. Supports include=clients to expand the updated site.

PATCH

site

{id}

Update a site

curl --request PATCH \
  --url https://connect.provisionapp.io/v1/site/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "businessName": "<string>",
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "isMonitored": true,
  "siteNotes": "<string>",
  "clientSegmentId": "<string>",
  "primaryClientId": "<string>",
  "tosAccepted": true,
  "ownerId": "ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344",
  "customProperties": {
    "warranty_count": 5,
    "region": "east",
    "onsite_required": true
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    businessName: '<string>',
    address1: '<string>',
    address2: '<string>',
    city: '<string>',
    state: '<string>',
    zip: '<string>',
    isMonitored: true,
    siteNotes: '<string>',
    clientSegmentId: '<string>',
    primaryClientId: '<string>',
    tosAccepted: true,
    ownerId: 'ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344',
    customProperties: {warranty_count: 5, region: 'east', onsite_required: true}
  })
};

fetch('https://connect.provisionapp.io/v1/site/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://connect.provisionapp.io/v1/site/{id}"

payload = {
    "businessName": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "isMonitored": True,
    "siteNotes": "<string>",
    "clientSegmentId": "<string>",
    "primaryClientId": "<string>",
    "tosAccepted": True,
    "ownerId": "ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344",
    "customProperties": {
        "warranty_count": 5,
        "region": "east",
        "onsite_required": True
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "tosAccepted": "<string>",
  "clientSegment": "<string>",
  "cppExpDate": "2023-11-07T05:31:56Z",
  "businessName": "<string>",
  "brandId": "<string>",
  "primaryClientId": "<string>",
  "primaryProjectId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sla": 123,
  "isMonitored": true,
  "accountManager": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "membershipRegistered": true,
  "clients": [
    {
      "id": "<string>",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "partnerName": "<string>",
      "marketingOptOut": true,
      "emails": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "value": "jsmith@example.com",
          "label": "<string>",
          "isPrimary": true
        }
      ],
      "phoneNumbers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "value": "<string>",
          "ext": 123,
          "label": "<string>",
          "isPrimary": true
        }
      ],
      "isPrimary": true
    }
  ],
  "projects": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "isPrimary": true,
      "stage": "<string>",
      "estimatedDay1": "2023-12-25",
      "day1StartDate": "2023-12-25",
      "warrantyExpiration": "2023-12-25",
      "signingDate": "2023-12-25"
    }
  ],
  "customProperties": {
    "warranty_count": 5,
    "region": "east",
    "onsite_required": true
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

Send the API key in the x-api-key header.

Path Parameters

string

required

Pattern: ^ovaid-.*$

Example:

"ovaid-22222222-2222-4222-8222-222222222222"

Query Parameters

include

string

Comma-separated relations to expand on the response

Example:

"clients,projects"

Body

application/json

businessName

string

Minimum string length: 1

address1

string

Minimum string length: 1

address2

string

city

string

Minimum string length: 1

state

string

Minimum string length: 1

zip

string

isMonitored

boolean

siteNotes

string

clientSegmentId

string

Minimum string length: 1

primaryClientId

string

Pattern: ^ovcid-.*$

tosAccepted

boolean

platformSlaId

enum<string>

Available options:

essentials_plus,

priority,

security_only,

proactive,

signature

ownerId

string

Platform user id. Newer ids are ovuid-<uuid>; legacy users may have bare (e.g. numeric) ids.

Minimum string length: 1

Example:

"ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344"

customProperties

object

Custom property values, keyed by property id. Ids and value types come from the properties defined for your partner, so this object cannot be described field by field here: an unknown id or a value that does not match the property type is rejected with 400. Only the ids you send are modified — omit a property to leave it untouched. To clear one, send null; a blank string and an empty array count as empty too, for every property type alike.

Show child attributes

Example:

{
  "warranty_count": 5,
  "region": "east",
  "onsite_required": true
}

Response

Updated site

string

required

address1

string | null

required

address2

string | null

required

city

string | null

required

state

string | null

required

zip

string | null

required

tosAccepted

string

serviceLevel

enum<string>

Available options:

Inactive,

Non-Member,

Warranty Essentials,

CPP Essentials Plus,

Essentials Plus,

CPP Priority,

Priority,

CPP Proactive,

Proactive,

CPP Signature,

Signature,

Secure,

OV - Internal,

Legacy

clientSegment

string

cppExpDate

string<date-time>

businessName

string

brandId

string

primaryClientId

string

primaryProjectId

string

createdAt

string<date-time>

updatedAt

string<date-time>

sla

number

isMonitored

boolean

accountManager

object

Show child attributes

membershipRegistered

boolean

clients

object[]

Show child attributes

projects

object[]

Show child attributes

customProperties

object

Custom property values, keyed by property id. Ids and value types come from the properties defined for your partner, so this object cannot be described field by field here — call the custom-property list endpoint to resolve an id to its name and type. A property never given a value takes the default configured for it, and is left out rather than returned as null when there is no default either. A value stored before its property was changed — an option renamed or removed, the type switched — is returned as stored, so it may not match the type the property has today; an absent key is the only reliable sign that nothing is set.

Show child attributes

Example:

{
  "warranty_count": 5,
  "region": "east",
  "onsite_required": true
}

Update a site

curl --request PATCH \
  --url https://connect.provisionapp.io/v1/site/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "businessName": "<string>",
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "isMonitored": true,
  "siteNotes": "<string>",
  "clientSegmentId": "<string>",
  "primaryClientId": "<string>",
  "tosAccepted": true,
  "ownerId": "ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344",
  "customProperties": {
    "warranty_count": 5,
    "region": "east",
    "onsite_required": true
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    businessName: '<string>',
    address1: '<string>',
    address2: '<string>',
    city: '<string>',
    state: '<string>',
    zip: '<string>',
    isMonitored: true,
    siteNotes: '<string>',
    clientSegmentId: '<string>',
    primaryClientId: '<string>',
    tosAccepted: true,
    ownerId: 'ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344',
    customProperties: {warranty_count: 5, region: 'east', onsite_required: true}
  })
};

fetch('https://connect.provisionapp.io/v1/site/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://connect.provisionapp.io/v1/site/{id}"

payload = {
    "businessName": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "isMonitored": True,
    "siteNotes": "<string>",
    "clientSegmentId": "<string>",
    "primaryClientId": "<string>",
    "tosAccepted": True,
    "ownerId": "ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344",
    "customProperties": {
        "warranty_count": 5,
        "region": "east",
        "onsite_required": True
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "tosAccepted": "<string>",
  "clientSegment": "<string>",
  "cppExpDate": "2023-11-07T05:31:56Z",
  "businessName": "<string>",
  "brandId": "<string>",
  "primaryClientId": "<string>",
  "primaryProjectId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sla": 123,
  "isMonitored": true,
  "accountManager": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "membershipRegistered": true,
  "clients": [
    {
      "id": "<string>",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "partnerName": "<string>",
      "marketingOptOut": true,
      "emails": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "value": "jsmith@example.com",
          "label": "<string>",
          "isPrimary": true
        }
      ],
      "phoneNumbers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "value": "<string>",
          "ext": 123,
          "label": "<string>",
          "isPrimary": true
        }
      ],
      "isPrimary": true
    }
  ],
  "projects": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "isPrimary": true,
      "stage": "<string>",
      "estimatedDay1": "2023-12-25",
      "day1StartDate": "2023-12-25",
      "warrantyExpiration": "2023-12-25",
      "signingDate": "2023-12-25"
    }
  ],
  "customProperties": {
    "warranty_count": 5,
    "region": "east",
    "onsite_required": true
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

system

site

conversation

client

user

Update a site

Authorizations

Path Parameters

Query Parameters

Body

Response