SVsvix
Application

Patch Application

Changed on

Partially update an application.

patch/api/v1/app/{app_id}

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/app/{app_id}
  • Auth
    HTTP bearer

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

Request body

metadataobject
namestring
throttleRateinteger nullable

Maximum messages per second to send to this application.

Outgoing messages will be throttled to this rate.

uidstring nullable

The Application's UID.

Example request

{
  "uid": "unique-identifier"
}

Response

createdAtstring date-time required
idstring required

The Application's ID.

metadataobject required
namestring required

Application name for human consumption.

throttleRateinteger nullable

Maximum messages per second to send to this application.

Outgoing messages will be throttled to this rate.

uidstring nullable

Optional unique identifier for the application.

updatedAtstring date-time required

Example response

{
  "id": "app_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "name": "My first application",
  "uid": "unique-identifier"
}

Changes

  • 36b59828b304Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • warning

      the request property's maxLength was set to 512

  • cca56e67e5a4Revision changes
    • info

      added the required property to the response with the status