Fresh 2026

SOP: Write Data with /meta

Procedure to create or update a record across any integration using the meta-first pattern.

Prerequisites

• A Linked Account with write scopes enabled.
• The Common Model you want to write (for example Candidate, Invoice, Ticket).

Procedure

1. Fetch field requirements. Call the model's /meta endpoint (GET /{model}/meta) for the Linked Account. Read the required and optional fields it returns. Requirements vary by integration.
2. Build the request body. Populate the body from the meta response so it matches that integration's needs. Do not hardcode fields.
3. Submit the write. POST /{model} to create or PATCH /{model}/{id} to update.
4. Handle nested relations. If the record references related records, include them as nested writes in the same request.
5. Inspect the response. Confirm the record id and that the change is reflected at the source.

Verification

• Write returns 201 (create) or 200 (update).
• A follow-up GET returns the new or updated record.

Related

• Programmatic Writes with /meta
• Making Writes
• Related and Nested Writes
• Writing Data Flow