Update organization design

Update an organization design’s name or description.

PATCH /api/v1/org/designs/{designUuidOrSlug}

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "files": [
      {
        "createdAt": "2023-11-07T05:31:56Z",
        "sizeBytes": 123,
        "contentType": "<string>",
        "filename": "<string>",
        "fileUuid": "<string>"
      }
    ],
    "createdByUserUuid": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "isDefault": true,
    "extraInstructions": "<string>",
    "description": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "organizationUuid": "<string>",
    "designUuid": "<string>"
  },
  "status": "ok"
}

Path Parameters

designUuidOrSlug · string · required

A resource UUID or its URL slug. Resolve to a real UUID before using as a key.

Body

application/json

extraInstructions · string | null

description · string | null

name · string

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok