proposals
POST /v1/proposals/{proposalId}/send
Issue the current edits as a new revision and e-mail the recipient a fresh link.
การยืนยันตัวตน
ส่ง API key เป็น bearer token เอนด์พอยต์นี้ไม่ได้ระบุสิทธิ์การใช้งานเฉพาะในข้อกำหนด ดังนั้นควรให้คีย์ของคุณมีสิทธิ์น้อยที่สุดเท่าที่จำเป็นและให้ตรวจสอบจากการตอบกลับแทนที่จะคาดเดา
ตำแหน่งสำหรับใส่รหัสองค์กรของคุณ
พอยต์ข้อมูลนี้รับ org_id เป็นพารามิเตอร์คิวรี หากเว้นว่างไว้ การเรียกใช้งานจะครอบคลุมย่อยของเทแนนท์ทั้งหมดของคุณ แต่หากระบุค่า จะช่วยจำกัดขอบเขตการเรียกให้เหลือเพียงองค์กรเดียว
รหัสองค์กรของคุณจะแสดงอยู่บนหน้าคีย์ API ในแดชบอร์ดของคุณ โดยอยู่ถัดจากคีย์นั้นๆ รหัสนี้จะเป็นรหัสเดิมในการเรียกใช้งานทุกครั้งของคุณ
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
curl -X POST https://api.zinndigital.com/v1/proposals/{proposalId}/send \
-H "Authorization: Bearer zdk_live_…"เข้าสู่ระบบแล้วใช่ไหม คอนโซล API ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง API จริง เพื่อให้คุณเห็นผลลัพธ์ที่เป็นข้อมูลจริง เปิดจุดสิ้นสุดนี้ในคอนโซล API
รายละเอียด
The link is returned ONCE as public_url and is never readable again (only its digest is stored). The previous link stops working. If the mail provider refuses, nothing is marked sent (503).
พารามิเตอร์
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
proposalId (path) | string | ใช่ | — |
org_id (query) | Uuid | ไม่ใช่ | Which of your organizations is invoicing. Required only when you belong to more than one — otherwise it is inferred from your DIRECT membership, never from the subtree-expanded… |
การตอบกลับ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
id | string | ใช่ | — |
reference | string | ใช่ | — |
status | ProposalStatus | ใช่ | — |
title | string | ใช่ | — |
currency | string | ใช่ | — |
recipient_name | string | ใช่ | — |
recipient_email | string | ใช่ | — |
recipient_company | string | ไม่ใช่ | — |
revision | integer | ใช่ | — |
valid_until | object | ไม่ใช่ | — |
sent_at | object | ไม่ใช่ | — |
decided_at | object | ไม่ใช่ | — |
paid_at | object | ไม่ใช่ | — |
board_id | object | ไม่ใช่ | — |
created_at | string | ใช่ | — |
updated_at | string | ไม่ใช่ | — |
message | string | ไม่ใช่ | — |
terms | string | ไม่ใช่ | — |
agency_tax_rate_id | object | ไม่ใช่ | — |
recipient_country | string | ไม่ใช่ | — |
recipient_tax_id | string | ไม่ใช่ | — |
recipient_locale | string | ไม่ใช่ | — |
accepted_revision | object | ไม่ใช่ | — |
accepted_by_name | string | ไม่ใช่ | — |
source_request_id | object | ไม่ใช่ | — |
completed_at | object | ไม่ใช่ | — |
lines | ProposalLine[] | ใช่ | — |
totals | ProposalTotals | ใช่ | — |
invoice | ProposalInvoice | null | ไม่ใช่ | — |
events | ProposalEvent[] | ใช่ | — |
editable | boolean | ใช่ | — |
public_url | string | ไม่ใช่ | Returned ONCE, by send. Never readable again. |
ข้อผิดพลาดที่เอนด์พอยต์นี้สามารถส่งกลับได้
401 · 403 · 404 · 409 · 503