Skip to main content

Save or Update OutOfOffice​


ApiScope: manage.outofoffice.write
API Scope Level: DepartmentScope
Path Parameters
    ServiceSubscriberDepartment string required
    dealerAssociate string required
Request Body required
    outOfOfficeSetterUserUUID string
    outOfOfficeSetterUserName string
    startTime string
    endTime string
    turnOffNumber string
    outOfOfficeType string
    outOfOfficeForwardingDetail object
    forwardText boolean
    forwardEmail boolean
    forwardCall boolean
    textForwardingNumber string
    emailForwardingAddress string
    callForwardingNumber string
    outOfOfficeAutoRespondDetail object
    enableTextAutoReply boolean
    enableEmailAutoReply boolean
    enableCallAutoReply boolean
    autoTextReply string
    autoEmailReplySubject string
    autoEmailReplyBody string
    autoCallReplyUrl string
    outOfOfficeDelegationDetail object
    delegateeDealerAssociateUUID string
    delegateeDealerAssociateName string
Responses

OK

Schema
    errors object[]
  • Array [
    • errorCode int32
    errorTitle string
    errorMessage string
  • ]
    • warnings object[]
  • Array [
    • warningCode int32
    warningTitle string
    warningMessage string
  • ]
    • apiRequestId string
PUT /v2/department/:ServiceSubscriberDepartment/dealerAssociate/:dealerAssociate/outofoffice

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL
/manage
Username
Password
ServiceSubscriberDepartment — path required
dealerAssociate — path required
Body required
{

  "outOfOfficeSetterUserUUID": "string",

  "outOfOfficeSetterUserName": "string",

  "startTime": "string",

  "endTime": "string",

  "turnOffNumber": "string",

  "outOfOfficeType": "string",

  "outOfOfficeForwardingDetail": {

    "forwardText": true,

    "forwardEmail": true,

    "forwardCall": true,

    "textForwardingNumber": "string",

    "emailForwardingAddress": "string",

    "callForwardingNumber": "string"

  },

  "outOfOfficeAutoRespondDetail": {

    "enableTextAutoReply": true,

    "enableEmailAutoReply": true,

    "enableCallAutoReply": true,

    "autoTextReply": "string",

    "autoEmailReplySubject": "string",

    "autoEmailReplyBody": "string",

    "autoCallReplyUrl": "string"

  },

  "outOfOfficeDelegationDetail": {

    "delegateeDealerAssociateUUID": "string",

    "delegateeDealerAssociateName": "string"

  }

}
Accept
curl / cURL
curl -L -X PUT '/manage/v2/department/:ServiceSubscriberDepartment/dealerAssociate/:dealerAssociate/outofoffice' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "outOfOfficeSetterUserUUID": "string",
  "outOfOfficeSetterUserName": "string",
  "startTime": "string",
  "endTime": "string",
  "turnOffNumber": "string",
  "outOfOfficeType": "string",
  "outOfOfficeForwardingDetail": {
    "forwardText": true,
    "forwardEmail": true,
    "forwardCall": true,
    "textForwardingNumber": "string",
    "emailForwardingAddress": "string",
    "callForwardingNumber": "string"
  },
  "outOfOfficeAutoRespondDetail": {
    "enableTextAutoReply": true,
    "enableEmailAutoReply": true,
    "enableCallAutoReply": true,
    "autoTextReply": "string",
    "autoEmailReplySubject": "string",
    "autoEmailReplyBody": "string",
    "autoCallReplyUrl": "string"
  },
  "outOfOfficeDelegationDetail": {
    "delegateeDealerAssociateUUID": "string",
    "delegateeDealerAssociateName": "string"
  }
}'