Sign in
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

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

Changed in 1 of the 6 revisions of this API.2

  • dc130bd1b0742See the full diff
    • ●

      removed the request property rateLimit

      request-property-removed

    • ●

      removed the optional property rateLimit from the response with the 200 status

      response-optional-property-removed

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog