เวอร์ชันของ API กราฟ

Canvas Header

การอ่าน

A header inside the canvas.

Example

พารามิเตอร์

จุดสิ้นสุดนี้ไม่ต้องพารามิเตอร์ใดๆ

ช่อง

ช่องคำอธิบาย
id
numeric string

The id of the element

background_color
string

The background color of the header

bottom_padding
numeric string

The padding below the element

child_elements
list<CanvasPhoto>

The child elements inside the header. You can only specify images, not text or other media.

element_group_key
string

The element group key to bundle multiple elements in editing

element_type
enum

The type of the element

name
string

The name of the element

top_padding
numeric string

The padding above the element

Error Codes

ข้อผิดพลาดคำอธิบาย
200Permissions error

การสร้าง

คุณไม่สามารถดำเนินการนี้ที่ปลายทางนี้

กำลังอัพเดต

คุณไม่สามารถดำเนินการนี้ที่ปลายทางนี้

กำลังลบ

You can delete a CanvasHeader by making a DELETE request to /{canvas_header_id}.

พารามิเตอร์

จุดสิ้นสุดนี้ไม่ต้องพารามิเตอร์ใดๆ

ประเภทการส่งกลับ

Struct {
success: bool,
}

Error Codes

ข้อผิดพลาดคำอธิบาย
100Invalid parameter