Перейти к основному содержанию
PATCH
/
v2
/
documents
/
templates
/
{id}
cURL
curl --request PATCH \
  --url https://api.example.com/v2/documents/templates/{id}/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "content_type": "client",
  "filter": "<unknown>",
  "created_by": 0,
  "points": [
    -1
  ],
  "status": "active",
  "order": -1,
  "format": "Letter",
  "width": "<string>",
  "height": "<string>",
  "margin_left": "<string>",
  "margin_right": "<string>",
  "margin_top": "<string>",
  "margin_bottom": "<string>",
  "scale": "<string>",
  "content": "<string>"
}
'
{
  "id": 123,
  "name": "<string>",
  "content_type": "client",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "content": "<string>",
  "filter": "<unknown>",
  "created_by": 0,
  "points": [
    -1
  ],
  "status": "active",
  "order": -1,
  "format": "Letter",
  "width": "<string>",
  "height": "<string>",
  "margin_left": "<string>",
  "margin_right": "<string>",
  "margin_top": "<string>",
  "margin_bottom": "<string>",
  "scale": "<string>"
}

Параметры пути

id
integer
обязательно

Тело

name
string
Maximum string length: 255
content_type
enum<string>
  • client - client
  • orderrequest - orderrequest
Доступные опции:
client,
orderrequest
filter
any
created_by
integer<int64> | null
Требуемый диапазон: -9223372036854776000 <= x <= 9223372036854776000
points
integer[]
Требуемый диапазон: -2147483648 <= x <= 2147483647
status
enum<string>
  • active - active
  • disabled - disabled
Доступные опции:
active,
disabled
order
integer | null
Требуемый диапазон: -2147483648 <= x <= 2147483647
format
enum<string>
  • Letter - Letter (21,6 x 27,9 см)
  • Tabloid - Tabloid (27,9 x 43,2 см)
  • Legal - Legal (21,6 x 35,6 см)
  • Statement - Statement (14,0 x 21,6 см)
  • Executive - Executive (18,4 x 26,7 см)
  • Folio - Folio (21,6 x 33,0 см)
  • A3 - A3 (29,7 x 42,0 см)
  • A4 - A4 (21,0 x 29,7 см)
  • A5 - A5 (14,8 x 21,0 см)
  • B4 - B4 (25,0 x 35,3 см)
  • B5 - B5 (17,6 x 25,0 см)
  • Custom - Другой размер
Доступные опции:
Letter,
Tabloid,
Legal,
Statement,
Executive,
Folio,
A3,
A4,
A5,
B4,
B5,
Custom
width
string<decimal>
Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
height
string<decimal>
Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
margin_left
string<decimal>
Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
margin_right
string<decimal>
Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
margin_top
string<decimal>
Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
margin_bottom
string<decimal>
Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
scale
string<decimal>
Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
content
string

Ответ

200 - application/json
id
integer
обязательно
name
string
обязательно
Maximum string length: 255
content_type
enum<string>
обязательно
  • client - client
  • orderrequest - orderrequest
Доступные опции:
client,
orderrequest
created_at
string<date-time>
обязательно
updated_at
string<date-time>
обязательно
content
string
обязательно
filter
any
created_by
integer<int64> | null
Требуемый диапазон: -9223372036854776000 <= x <= 9223372036854776000
points
integer[]
Требуемый диапазон: -2147483648 <= x <= 2147483647
status
enum<string>
  • active - active
  • disabled - disabled
Доступные опции:
active,
disabled
order
integer | null
Требуемый диапазон: -2147483648 <= x <= 2147483647
format
enum<string>
  • Letter - Letter (21,6 x 27,9 см)
  • Tabloid - Tabloid (27,9 x 43,2 см)
  • Legal - Legal (21,6 x 35,6 см)
  • Statement - Statement (14,0 x 21,6 см)
  • Executive - Executive (18,4 x 26,7 см)
  • Folio - Folio (21,6 x 33,0 см)
  • A3 - A3 (29,7 x 42,0 см)
  • A4 - A4 (21,0 x 29,7 см)
  • A5 - A5 (14,8 x 21,0 см)
  • B4 - B4 (25,0 x 35,3 см)
  • B5 - B5 (17,6 x 25,0 см)
  • Custom - Другой размер
Доступные опции:
Letter,
Tabloid,
Legal,
Statement,
Executive,
Folio,
A3,
A4,
A5,
B4,
B5,
Custom
width
string<decimal>
Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
height
string<decimal>
Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
margin_left
string<decimal>
Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
margin_right
string<decimal>
Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
margin_top
string<decimal>
Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
margin_bottom
string<decimal>
Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
scale
string<decimal>
Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$