DEVELOPER PLATFORM · v1

An API you can build with

CRM, campaigns, analytics and integrations. Exact contracts, practical examples and signed webhooks.

Download OpenAPI

Private preview: use a project API key. Public SLA and support windows have not been established yet.

PUT

Update Developer Crm Ticket Sla Policy

/api/v1/developer/crm/tickets/sla-policy

Use the access scope below. The generated schemas specify the exact request and responses.

Access scopecrm.tickets.sla.write

Authorization: Bearer YOUR_PROJECT_TOKEN

Parameters

idempotency-keyrequired · header: stringpattern: "^[\\x21-\\x7E]+$" · minLength: 1 · maxLength: 160
JSON Schema
{ "type": "string", "minLength": 1, "maxLength": 160, "pattern": "^[\\x21-\\x7E]+$" }

Request body

application/json

object

targetsrequired

object

Nested schema

object

lowrequired

object

Nested schema

object

firstResponseMinutesrequired: integerminimum: 1
resolutionMinutesrequired: integerminimum: 1

JSON Schema

{
  "type": "object",
  "properties": {
    "firstResponseMinutes": {
      "type": "integer",
      "minimum": 1
    },
    "resolutionMinutes": {
      "type": "integer",
      "minimum": 1
    }
  },
  "required": [
    "firstResponseMinutes",
    "resolutionMinutes"
  ],
  "additionalProperties": false
}

normalrequired

object

Nested schema

object

firstResponseMinutesrequired: integerminimum: 1
resolutionMinutesrequired: integerminimum: 1

JSON Schema

{
  "type": "object",
  "properties": {
    "firstResponseMinutes": {
      "type": "integer",
      "minimum": 1
    },
    "resolutionMinutes": {
      "type": "integer",
      "minimum": 1
    }
  },
  "required": [
    "firstResponseMinutes",
    "resolutionMinutes"
  ],
  "additionalProperties": false
}

highrequired

object

Nested schema

object

firstResponseMinutesrequired: integerminimum: 1
resolutionMinutesrequired: integerminimum: 1

JSON Schema

{
  "type": "object",
  "properties": {
    "firstResponseMinutes": {
      "type": "integer",
      "minimum": 1
    },
    "resolutionMinutes": {
      "type": "integer",
      "minimum": 1
    }
  },
  "required": [
    "firstResponseMinutes",
    "resolutionMinutes"
  ],
  "additionalProperties": false
}

urgentrequired

object

Nested schema

object

firstResponseMinutesrequired: integerminimum: 1
resolutionMinutesrequired: integerminimum: 1

JSON Schema

{
  "type": "object",
  "properties": {
    "firstResponseMinutes": {
      "type": "integer",
      "minimum": 1
    },
    "resolutionMinutes": {
      "type": "integer",
      "minimum": 1
    }
  },
  "required": [
    "firstResponseMinutes",
    "resolutionMinutes"
  ],
  "additionalProperties": false
}

JSON Schema

{
  "type": "object",
  "properties": {
    "low": {
      "type": "object",
      "properties": {
        "firstResponseMinutes": {
          "type": "integer",
          "minimum": 1
        },
        "resolutionMinutes": {
          "type": "integer",
          "minimum": 1
        }
      },
      "required": [
        "firstResponseMinutes",
        "resolutionMinutes"
      ],
      "additionalProperties": false
    },
    "normal": {
      "type": "object",
      "properties": {
        "firstResponseMinutes": {
          "type": "integer",
          "minimum": 1
        },
        "resolutionMinutes": {
          "type": "integer",
          "minimum": 1
        }
      },
      "required": [
        "firstResponseMinutes",
        "resolutionMinutes"
      ],
      "additionalProperties": false
    },
    "high": {
      "type": "object",
      "properties": {
        "firstResponseMinutes": {
          "type": "integer",
          "minimum": 1
        },
        "resolutionMinutes": {
          "type": "integer",
          "minimum": 1
        }
      },
      "required": [
        "firstResponseMinutes",
        "resolutionMinutes"
      ],
      "additionalProperties": false
    },
    "urgent": {
      "type": "object",
      "properties": {
        "firstResponseMinutes": {
          "type": "integer",
          "minimum": 1
        },
        "resolutionMinutes": {
          "type": "integer",
          "minimum": 1
        }
      },
      "required": [
        "firstResponseMinutes",
        "resolutionMinutes"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "low",
    "normal",
    "high",
    "urgent"
  ],
  "additionalProperties": false
}

businessHours

union

Nested schema

union

Variant 1

object

kindrequired: stringenum: ["always"]

JSON Schema

{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "always"
      ]
    }
  },
  "required": [
    "kind"
  ],
  "additionalProperties": false
}

Variant 2

object

kindrequired: stringenum: ["weekly"]
weekdaysrequired: arrayminItems: 1 · maxItems: 7
Nested schema
arrayminItems: 1 · maxItems: 7
union
JSON Schema
{ "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] }, { "type": "number", "enum": [ 6 ] }, { "type": "number", "enum": [ 7 ] } ] }
JSON Schema
{ "type": "array", "items": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] }, { "type": "number", "enum": [ 6 ] }, { "type": "number", "enum": [ 7 ] } ] }, "minItems": 1, "maxItems": 7 }
startMinuterequired: integerminimum: 0 · maximum: 1439
endMinuterequired: integerminimum: 1 · maximum: 1440

JSON Schema

{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "weekly"
      ]
    },
    "weekdays": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "number",
            "enum": [
              1
            ]
          },
          {
            "type": "number",
            "enum": [
              2
            ]
          },
          {
            "type": "number",
            "enum": [
              3
            ]
          },
          {
            "type": "number",
            "enum": [
              4
            ]
          },
          {
            "type": "number",
            "enum": [
              5
            ]
          },
          {
            "type": "number",
            "enum": [
              6
            ]
          },
          {
            "type": "number",
            "enum": [
              7
            ]
          }
        ]
      },
      "minItems": 1,
      "maxItems": 7
    },
    "startMinute": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1439
    },
    "endMinute": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    }
  },
  "required": [
    "kind",
    "weekdays",
    "startMinute",
    "endMinute"
  ],
  "additionalProperties": false
}

JSON Schema

{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "always"
          ]
        }
      },
      "required": [
        "kind"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "weekly"
          ]
        },
        "weekdays": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "number",
                "enum": [
                  1
                ]
              },
              {
                "type": "number",
                "enum": [
                  2
                ]
              },
              {
                "type": "number",
                "enum": [
                  3
                ]
              },
              {
                "type": "number",
                "enum": [
                  4
                ]
              },
              {
                "type": "number",
                "enum": [
                  5
                ]
              },
              {
                "type": "number",
                "enum": [
                  6
                ]
              },
              {
                "type": "number",
                "enum": [
                  7
                ]
              }
            ]
          },
          "minItems": 1,
          "maxItems": 7
        },
        "startMinute": {
          "type": "integer",
          "minimum": 0,
          "maximum": 1439
        },
        "endMinute": {
          "type": "integer",
          "minimum": 1,
          "maximum": 1440
        }
      },
      "required": [
        "kind",
        "weekdays",
        "startMinute",
        "endMinute"
      ],
      "additionalProperties": false
    }
  ]
}

JSON Schema

{
  "type": "object",
  "properties": {
    "targets": {
      "type": "object",
      "properties": {
        "low": {
          "type": "object",
          "properties": {
            "firstResponseMinutes": {
              "type": "integer",
              "minimum": 1
            },
            "resolutionMinutes": {
              "type": "integer",
              "minimum": 1
            }
          },
          "required": [
            "firstResponseMinutes",
            "resolutionMinutes"
          ],
          "additionalProperties": false
        },
        "normal": {
          "type": "object",
          "properties": {
            "firstResponseMinutes": {
              "type": "integer",
              "minimum": 1
            },
            "resolutionMinutes": {
              "type": "integer",
              "minimum": 1
            }
          },
          "required": [
            "firstResponseMinutes",
            "resolutionMinutes"
          ],
          "additionalProperties": false
        },
        "high": {
          "type": "object",
          "properties": {
            "firstResponseMinutes": {
              "type": "integer",
              "minimum": 1
            },
            "resolutionMinutes": {
              "type": "integer",
              "minimum": 1
            }
          },
          "required": [
            "firstResponseMinutes",
            "resolutionMinutes"
          ],
          "additionalProperties": false
        },
        "urgent": {
          "type": "object",
          "properties": {
            "firstResponseMinutes": {
              "type": "integer",
              "minimum": 1
            },
            "resolutionMinutes": {
              "type": "integer",
              "minimum": 1
            }
          },
          "required": [
            "firstResponseMinutes",
            "resolutionMinutes"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "low",
        "normal",
        "high",
        "urgent"
      ],
      "additionalProperties": false
    },
    "businessHours": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "always"
              ]
            }
          },
          "required": [
            "kind"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "weekly"
              ]
            },
            "weekdays": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  {
                    "type": "number",
                    "enum": [
                      2
                    ]
                  },
                  {
                    "type": "number",
                    "enum": [
                      3
                    ]
                  },
                  {
                    "type": "number",
                    "enum": [
                      4
                    ]
                  },
                  {
                    "type": "number",
                    "enum": [
                      5
                    ]
                  },
                  {
                    "type": "number",
                    "enum": [
                      6
                    ]
                  },
                  {
                    "type": "number",
                    "enum": [
                      7
                    ]
                  }
                ]
              },
              "minItems": 1,
              "maxItems": 7
            },
            "startMinute": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1439
            },
            "endMinute": {
              "type": "integer",
              "minimum": 1,
              "maximum": 1440
            }
          },
          "required": [
            "kind",
            "weekdays",
            "startMinute",
            "endMinute"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": [
    "targets"
  ],
  "additionalProperties": false,
  "$ref": "#/components/schemas/UpdateDeveloperCrmTicketSlaPolicyRequest"
}

Request examples

curl --request PUT   'https://YOUR_NOVA_HOST/api/v1/developer/crm/tickets/sla-policy'   --header 'Authorization: Bearer YOUR_PROJECT_TOKEN'   --header 'Idempotency-Key: YOUR_UNIQUE_COMMAND_ID'   --header 'Content-Type: application/json'   --data '{"targets":{"low":{"firstResponseMinutes":1440,"resolutionMinutes":4320},"normal":{"firstResponseMinutes":480,"resolutionMinutes":1440},"high":{"firstResponseMinutes":120,"resolutionMinutes":480},"urgent":{"firstResponseMinutes":30,"resolutionMinutes":120}},"businessHours":{"kind":"weekly","weekdays":[1,2,3,4,5],"startMinute":540,"endMinute":1080}}'

Responses

200 Updated CRM ticket SLA receipt

application/json

object

resourceIdrequired: stringminLength: 1 · maxLength: 160
changedrequired: boolean

JSON Schema

{
  "type": "object",
  "properties": {
    "resourceId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "changed": {
      "type": "boolean"
    }
  },
  "required": [
    "resourceId",
    "changed"
  ],
  "$ref": "#/components/schemas/DeveloperMutationResponse"
}

400 Invalid SLA policy or idempotency key

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

401 Invalid developer credential

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

403 CRM tickets entitlement or membership unavailable

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

409 Idempotency key conflict or client unavailable for a new ticket

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

429 Developer API rate limit exceeded

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

503 Developer API rate limiter unavailable

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}