Create a new Live Activity

post

https://api.indigitall.com/v2/pushlive/{appId}/activity

Path Params

appId

number

required

Customer application id

Body Params

liveActivityExternalId

string

required

length between 5 and 30

External identifier for the Live Activity, defined by the user. It is unique per application and allows full traceability at all times. Must be alphanumeric with underscores (_) and cannot contain spaces or other special characters.

iosClassId

integer | null

iOS Class id

name

string | null

The name of the Live Activity, which should be a meaningful, short title. It must be between 5 and 100 characters long, and can contain letters, numbers, spaces, and some punctuation marks. Example: "Football Match - Team A vs Team B".

staticAttributes

object | null

This field overwrite staticAttributes values of live activity. The dictionary that contains data you pass to a Live Activity that you start with a remote push notification with static data during the live activity cycle. iOS platform should keep the same structure of your application and same structure that iosClass attributes. For more information, see attributes in Official Apple Docs.

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Live Activity created

defaultError 5XX, 4XX