Skip to Content

EnterpriseApi

All URIs are relative to https://business.apis.kesk.app/v1 

MethodHTTP requestDescription
addEnterpriseDomainPOST /enterprises/{enterprise_id}/domainsAdd domain to enterprise
developerDeleteEnterpriseDomainDELETE /enterprises/{enterprise_id}/domains/{domain_id}Delete enterprise domain
developerListEnterpriseDomainsGET /enterprises/{enterprise_id}/domainsList enterprise domains
developerUpdateEnterpriseDomainPUT /enterprises/{enterprise_id}/domains/{domain_id}Update enterprise domain
developerVerifyEnterpriseDomainPOST /enterprises/{enterprise_id}/domains/{domain_id}/verifyVerify domain
getDomainVerificationInstructionsGET /enterprises/{enterprise_id}/domains/{domain_id}/verificationGet domain verification instructions

addEnterpriseDomain

EnterpriseDomainResponse addEnterpriseDomain(enterprise_id, AddEnterpriseDomainRequest)

Add domain to enterprise

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
AddEnterpriseDomainRequestAddEnterpriseDomainRequest

Return type

EnterpriseDomainResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

developerDeleteEnterpriseDomain

DeleteResponse developerDeleteEnterpriseDomain(enterprise_id, domain_id)

Delete enterprise domain

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
domain_idLong[default to null]

Return type

DeleteResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

developerListEnterpriseDomains

PaginatedResponse_EnterpriseDomainResponse developerListEnterpriseDomains(enterprise_id, page, per_page)

List enterprise domains

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
pageLong[optional] [default to null]
per_pageLong[optional] [default to null]

Return type

PaginatedResponse_EnterpriseDomainResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

developerUpdateEnterpriseDomain

EnterpriseDomainResponse developerUpdateEnterpriseDomain(enterprise_id, domain_id, UpdateEnterpriseDomainRequest)

Update enterprise domain

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
domain_idLong[default to null]
UpdateEnterpriseDomainRequestUpdateEnterpriseDomainRequest

Return type

EnterpriseDomainResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

developerVerifyEnterpriseDomain

DomainVerifyResponse developerVerifyEnterpriseDomain(enterprise_id, domain_id)

Verify domain

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
domain_idLong[default to null]

Return type

DomainVerifyResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getDomainVerificationInstructions

DomainVerificationInstructions getDomainVerificationInstructions(enterprise_id, domain_id)

Get domain verification instructions

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
domain_idLong[default to null]

Return type

DomainVerificationInstructions

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8