API v1 ReferenceUpdates
Create update
Create a draft update. Drafts are the only create behavior: save the update first, then call the publish or schedule endpoint when it is ready for customers.…
Create a draft update. Drafts are the only create behavior: save the update first, then call the publish or schedule endpoint when it is ready for customers. Follow-ups can only be created for published root updates. When parent is supplied, omit order; follow-up order is changed on the root update.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://app.orbiqhq.com/api/v1/updates" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "title": "SOC 2 Type II report published", "summary": "Our latest SOC 2 Type II report is now available.", "description_md": "Customers with approved access can now review the report.", "classification": "cls_compliance", "access_level": "restricted", "channels": ["trust_center", "email.subscribers"], "document_ids": ["doc_soc2"] }'{ "success": true, "data": { "update": { "id": "string", "title": "string", "slug": "string", "summary": "string", "description_md": "string", "status": "draft", "classification": "string", "access_level": "public", "send_mode": "none", "channels": [ "trust_center" ], "scheduled_at": "2019-08-24T14:15:22Z", "scheduled_timezone": "string", "published_at": "2019-08-24T14:15:22Z", "effective_at": "2019-08-24T14:15:22Z", "effective_timezone": "string", "order": "asc", "parent": "string", "template": "string", "documents": [ { "id": "string", "documents_id": "string" } ], "subprocessors": [ { "id": "string", "subprocessors_id": "string" } ] } }}How is this guide?