Skip to content
Connect an agent

Organisations

Choose the style of your diagrams

Your spacing, line shape, or both, for the flow diagrams you draw on the hosted service when no organisation decides it.

PUT/user/style

TL;DR

QuestionAnswer
What does it do?Choose the style of your diagrams.
What does it take?A JSON body of type SetUserStyleBody.
What does it return?Status 200 with a body of type UserStyle.
What can go wrong?400 the body is not valid; 401 not signed in; 403 the request came from an origin that may not make changes; 429 too many requests. Every failure uses the one error envelope.

What it does

Your spacing, line shape, or both, for the flow diagrams you draw on the hosted service when no organisation decides it.

Request body

The body has the type SetUserStyleBody.

FieldTypeRequiredDescription
spacing"compact" | "normal" | "roomy"no
edges"orthogonal" | "spline" | "straight"no

Responses

StatusMeaningBody
200The choice now.UserStyle
400The body is not valid.ErrorResponse
401Not signed in.ErrorResponse
403The request came from an origin that may not make changes.ErrorResponse
429Too many requests.ErrorResponse

Response body

A 200 answer has the type UserStyle.

FieldTypeRequiredDescription
spacing"compact" | "normal" | "roomy"yesHow far apart the boxes sit: compact, normal, or roomy. normal by default.
edges"orthogonal" | "spline" | "straight"yesHow the lines are drawn: orthogonal (straight runs, rounded corners), spline (curves), or straight (slanted). orthogonal by default.

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools