API Reference
Start typing to search…

Update Message Template

put
https://neon-config-qa.spika.com/config/v1//message-templates/
Path Params
string
required

The name of the space (database) assigned to you.

string
required
Body Params
string
length ≤ 15

Unique Internal Id of the entity. Set on creation and can't be changed. Lowercase letters, digits and underscore allowed. If not specified then an id will be generated.

string
required
length between 0 and 100

The unique name of the entity (case sensitive). Upper and lowercase, digits and undescore allowed. When referencing Entities by name in scripts, the name should be preceded by the '@' sign.

string
length between 0 and 50

An optional business identifier for the Entity. This may be a reference to a different system, and if specified must be unique across the platform. When looking up Entities by business Id, it must be preceded by the '$' sign.

string
length between 0 and 1000

An optional description of what the Entity is for.

string
length between 0 and 50

An optional free-text field which can be used by applications to categorize Entities or filter by and group related Entities.

string
enum
required

The Entity's state

Allowed:
json

Optional Dimension Gate, controlling under what circumstances the Entity is accessible. Not applicable for all Entity Types.

string
length between 0 and 50

Can contain the user Id of a portal user who the Entity belongs to.

config
object

Configuration JSON, specific to each type of Entry

string

Optional CMS Definition assigned to the Entity to control and validate associated CMS fields. Not applicable to all Entity Types.

string

Additional information about the Cms Definition Id.

cmsContent
object

Optional rich content associated with the Entity. Not applicable for all Entity Types.

Response

Updated 5 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago