Proposals

Propose changes to a diagram

Propose a schema patch to an existing diagram. DrawSQL stores the proposal and returns a review_url; the diagram does not change until an editor opens that link, reviews the diff in the editor, and applies it. Requires a token with the write ability whose user can edit the diagram.

The patch takes the full format, including deletions, positions and sizes, groups, and sticky notes. It is validated here and applied to the diagram as it is when the editor reviews it. title (up to 100 characters) and message (up to 500) are required; the reviewer sees them as plain text.

A proposal expires 30 days after it is made; an editor can reopen an expired proposal. Proposals are never deduplicated: every successful request makes a new one, so retry only a request that returned no uuid.

Rate limit: 10 requests/minute per token, one limit shared with POST /diagrams.

post/diagrams/{uuid}/proposals

Request

  • Base URL
    https://api.drawsql.app/v1
  • Auth
    HTTP bearer

Path parameters

uuidstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

The diagram's UUID.

Request body

titlestring required

A short title, like a pull request title, shown to the reviewer as plain text.

messagestring required

Why the change is needed, shown to the reviewer as plain text before they decide.

Response

The proposal was stored and is waiting for review.

Changes

No recorded changes to this operation across all 1 revision of this API.