Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Application

Create Application

Create a new application.

post/api/v1/app

Query parameters

get_if_existsboolean

Get an existing application, or create a new one if doesn't exist. It's two separate functions in the libs.

Get an existing application, or create a new one if doesn't exist. It's two separate functions in the libs.

Headers

idempotency-keystring

The request's idempotency key

Request body

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.

uidstring nullable

Optional unique identifier for the application.

metadataobject

Example request

{
  "name": "My first application",
  "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"
}