REST API reference · Application definitions

Update editable definition metadata¶

Read and manage reusable application structures.

PATCH/application-definitions/{definition_slug}/

Parameters¶

Name	Location	Type	Required
`definition_slug`	path	string	Yes
`If-Match`	header	string	Yes
`Idempotency-Key`	header	string	Yes

Request body¶

Send a body that matches the published schema.

View request schema

{
  "additionalProperties": false,
  "properties": {
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}

Request¶

curl --request PATCH \
  --url 'https://api.staging.levr.ai/api/external/v1/application-definitions/{definition_slug}/' \
  --header 'Authorization: Bearer $LEVR_API_TOKEN' \
  --header 'If-Match: $IF_MATCH' \
  --header 'Idempotency-Key: $IDEMPOTENCY_KEY' \
  --header 'Content-Type: application/json' \
  --data '@request.json'

Responses¶

Status	Description
`200`	Success
`400`	Correct the request fields and try again.
`401`	Provide a valid portal API token and try again.
`403`	This portal API token does not allow the requested action.
`404`	The requested resource was not found or is not available to this token.
`409`	The request conflicts with the resource's current state. Refresh it before trying again.
`412`	The request was not completed.
`429`	Too many requests were sent. Wait before trying again.
`500`	Levr could not complete the request. Keep the request ID and retry when safe.