PATCH /apps/{app_id}/namespaces/{namespace_id}

Updates the namespace with the specified ID, for the application with the specified application ID.

Servers

Path parameters

Name Type Required Description
app_id String Yes

The application ID.

namespace_id String Yes

The namespace ID.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
persisted Boolean No

If true, all messages on a channel will be stored for 24 hours. You can access stored messages via the History API. Please note that for each message stored, an additional message is deducted from your monthly allocation.

Default value: false

pushEnabled Boolean No

If true, publishing messages with a push payload in the extras field is permitted and can trigger the delivery of a native push notification to registered devices for the channel.

Default value: false

tlsOnly Boolean No

If true, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.

Default value: false

persistLast Boolean No

If true, the last message published on a channel will be stored for 365 days. You can access the stored message only by using the channel rewind mechanism and attaching with rewind=1. Please note that for each message stored, an additional message is deducted from your monthly allocation.

Default value: false

authenticated Boolean No

If true, clients will not be permitted to use (including to attach, publish, or subscribe) any channels within this namespace unless they are identified, that is, authenticated using a client ID. See the Ably knowledge base/a> for more details.

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.