PATCH /WorkApps/{workAppId}/CustomFields

Updates the custom field values associated to a WorkApp. A null value removes the field.

patch

Authorizations

API Key

Path parameters

workAppIdstring · uuidRequired

The Work App's unique identifier.

Header parameters

X-API-SECRETstringRequired

API Secret is used to verify the integrity of the request and authenticate the client. It should be included in all requests. This value must be kept confidential and should never be exposed in client-side code or public repositories.

Example: YOUR_API_SECRET

Body

application/jsontext/jsonapplication/*+json

all ofOptional

Request model used to update custom Fields for a workapp.

Responses

204

No Content

No content

401

Unauthorized

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

409

Conflict

text/plainapplication/jsontext/json

500

Internal Server Error

text/plainapplication/jsontext/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/WorkApps/{workAppId}/CustomFields HTTP/1.1
Host: open-api.getcakewalk.io
X-API-KEY: YOUR_API_KEY
X-API-SECRET: YOUR_API_SECRET
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "customFields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

No content