openapi: 3.1.0
info:
title: Helpcenter AgentSignatures API
version: 1.0.0
tags:
- name: AgentSignatures
paths:
/api/v1/agents/{agentId}/signatures:
get:
tags:
- AgentSignatures
summary: Get signatures of agent
description: This API fetches the different signatures configured by an agent.
operationId: getSignatures
parameters:
- $ref: '#/components/parameters/agentId'
- $ref: ./Common.json#/components/parameters/orgId
responses:
'200':
$ref: '#/components/responses/commonSignaturesResponse'
security:
- iam-oauth2-schema:
- Desk.settings.READ
x-audience:
- external-public
patch:
tags:
- AgentSignatures
summary: Update signatures of agent
description: This API updates the existing signatures of an agent.
operationId: updateSignatures
parameters:
- $ref: '#/components/parameters/agentId'
- $ref: ./Common.json#/components/parameters/orgId
requestBody:
$ref: '#/components/requestBodies/agentSignatureJson'
responses:
'200':
$ref: '#/components/responses/commonSignaturesResponse'
'422':
$ref: ./Common.json#/components/responses/invalidDataErrorResponse
security:
- iam-oauth2-schema:
- Desk.settings.UPDATE
x-audience:
- external-public
/api/v1/agents/{agentId}/updateCustomizedSignature:
post:
tags:
- AgentSignatures
summary: Update customized signatures of agent
description: This API updates the customized signatures of an agent.
operationId: updateCustomSignature
parameters:
- $ref: '#/components/parameters/agentId'
- $ref: ./Common.json#/components/parameters/orgId
requestBody:
$ref: '#/components/requestBodies/customSignatureJson'
responses:
'422':
$ref: ./Common.json#/components/responses/invalidDataErrorResponse
'200':
$ref: '#/components/responses/commonSignaturesResponse'
security:
- iam-oauth2-schema:
- Desk.settings.UPDATE
x-audience:
- external-public
components:
requestBodies:
agentSignatureJson:
content:
application/json:
schema:
type:
- 'null'
- object
additionalProperties: false
properties:
customizedSignatures:
$ref: ./AgentSignatures.json#/components/schemas/customSignatureList
defaultSignature:
type:
- string
- 'null'
maxLength: 65000
minLength: 0
isActive:
type:
- boolean
- 'null'
examples:
Valid requestBody Definitions:
value:
customizedSignatures:
- signature: '<div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div>Bonnie Runolfsson<br /></div><div><b>Manager</b><br /></div><div><b>Sales & Marketing</b><br /></div><div><b>@Surface Sureve Inc.</b><br /></div></div></div></div><div><div><br /></div></div><div><br /></div></div><div><br /></div></div><div><br /></div></div>'
departmentId: 4000000015063
defaultSignature: '<div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div>Bonnie Runolfsson<br /></div><div><b>@Surface Sureve Inc.</b><br /></div></div></div></div></div><div><br /></div></div>'
customSignatureJson:
content:
application/json:
schema:
type:
- 'null'
- object
additionalProperties: false
properties:
signature:
type:
- string
- 'null'
maxLength: 100
minLength: 0
departmentId:
type:
- string
- 'null'
- integer
format: int64
pattern: ([0-9]+)
required:
- departmentId
- signature
examples:
Valid requestBody Definitions:
value:
signature: '<div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div>Bonnie Runolfsson<br /></div><div><b>Manager</b><br /></div><div>Sales & Marketing<br /></div><div><b>@Surface Sureve Inc.</b><br /></div></div></div></div><div><div><br /></div></div><div><br /></div></div><div><br /></div></div><div><br /></div></div>'
departmentId: 4000000015063
responses:
commonSignaturesResponse:
description: commonSignaturesResponse template definitions
content:
application/json:
schema:
type:
- 'null'
- object
additionalProperties: false
properties:
customizedSignatures:
type:
- 'null'
- array
items:
type:
- 'null'
- object
additionalProperties: false
maxProperties: 2
minProperties: 2
properties:
signature:
type:
- string
- 'null'
maxLength: 100
minLength: 0
departmentId:
type:
- string
- 'null'
- integer
format: int64
pattern: ([0-9]+)
required:
- departmentId
- signature
uniqueItems: false
agentId:
type:
- string
- 'null'
- integer
format: int64
pattern: ([0-9]+)
defaultSignature:
type:
- string
- 'null'
maxLength: 65000
minLength: 0
id:
type:
- string
- 'null'
- integer
format: int64
pattern: ([0-9]+)
isActive:
type:
- boolean
- 'null'
required:
- agentId
- customizedSignatures
- defaultSignature
- id
- isActive
examples:
Valid responses Definitions:
value:
customizedSignatures:
- signature: '<div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div>Bonnie Runolfsson<br /></div><div><b>Manager</b><br /></div><div>Sales & Marketing<br /></div><div><b>@Surface Sureve Inc.</b><br /></div></div></div></div><div><div><br /></div></div><div><br /></div></div><div><br /></div></div><div><br /></div></div>'
departmentId: 4000000015063
agentId: 4000000012902
defaultSignature: '<div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div style="font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif"><div>Bonnie Runolfsson<br /></div><div><b>@Surface Sureve Inc.</b><br /></div></div></div></div></div><div><br /></div></div>'
id: '4000000012902'
isActive: true
parameters:
agentId:
name: agentId
in: path
required: true
style: simple
explode: false
schema:
type:
- string
- 'null'
- integer
format: int64
pattern: ([0-9]+)
securitySchemes:
iam-oauth2-schema:
$ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter