Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-054815267.9 KB
SyncV1SyncStream

Create a new Stream.

Create a new Stream.

post/v1/Services/{ServiceSid}/Streams

Path parameters

ServiceSidstring required

The SID of the Sync Service to create the new Stream in.

Response

Created

sidstring nullable

The unique string that we created to identify the Sync Stream resource.

unique_namestring nullable

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.

account_sidstring nullable

The SID of the Account that created the Sync Stream resource.

service_sidstring nullable

The SID of the Sync Service the resource is associated with.

urlstring uri nullable

The absolute URL of the Message Stream resource.

linksobject nullable

The URLs of the Stream's nested resources.

date_expiresstring date-time nullable

The date and time in GMT when the Message Stream expires and will be deleted, specified in ISO 8601 format. If the Message Stream does not expire, this value is null. The Stream might not be deleted immediately after it expires.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

created_bystring nullable

The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's identity field. If the Stream was created from the REST API, the value is 'system'.