Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Application

Patch Application

Partially update an application.

patch/api/v1/app/{app_id}

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

Request body

namestring
rateLimitinteger nullable

Deprecated, use throttleRate instead.

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.

metadataobject

Example request

{
  "uid": "unique-identifier"
}

Response

uidstring nullable

Optional unique identifier for the application.

namestring required

Application name for human consumption.

rateLimitinteger nullable

Deprecated, use throttleRate instead.

throttleRateinteger nullable

Maximum messages per second to send to this application.

Outgoing messages will be throttled to this rate.

idstring required

The Application's ID.

createdAtstring date-time required
updatedAtstring date-time required
metadataobject required

Example response

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