Update application - Placewise API

Request

Path Params

identifier

string

required

Example:

default

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

X-Client-Authorization

string

optional

Default:

Body Params application/json

application

object (Application)

required

identifier

string

required

Unique identifier for the Application. Will be used in API requests to identify it.

Example:

website

name

string | null

required

Optional display name

Example:

Website

welcome_message

object | null

required

optin_channels

array[string] | null

required

Specifies optin channels for new members on more granular level.

Example:

["fb_campaign_2018","fb_campaign_2019"]

enabled_properties

array[string] | null

required

Names of member properties that are relevant/available in context of this application.
When blank, a configuration from "default" Application will be used.

Example:

["msisdn","first_name"]

required_properties

array[string] | null

required

Names of member properties that are required to be present for members in context of this application.
When blank, a configuration from "default" Application will be used.

Example:

["msisdn"]

trusted_redirection_domains

array[string <hostname>] | null

required

When present, those domains will be available to provide as targets of custom redirection URLs generated by API to members

Example

{
  "application": {
    "identifier": "website",
    "name": "Website",
    "welcome_message": {
      "text": {
        "en": "Text"
      },
      "enabled": true
    },
    "optin_channels": [
      "fb_campaign_2018",
      "fb_campaign_2019"
    ],
    "enabled_properties": [
      "msisdn",
      "first_name"
    ],
    "required_properties": [
      "msisdn"
    ],
    "trusted_redirection_domains": [
      "example.com"
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

application

object (Application)

required

identifier

string

required

Unique identifier for the Application. Will be used in API requests to identify it.

Example:

website

name

string | null

required

Optional display name

Example:

Website

welcome_message

object | null

required

optin_channels

array[string] | null

required

Specifies optin channels for new members on more granular level.

Example:

["fb_campaign_2018","fb_campaign_2019"]

enabled_properties

array[string] | null

required

Names of member properties that are relevant/available in context of this application.
When blank, a configuration from "default" Application will be used.

Example:

["msisdn","first_name"]

required_properties

array[string] | null

required

Names of member properties that are required to be present for members in context of this application.
When blank, a configuration from "default" Application will be used.

Example:

["msisdn"]

trusted_redirection_domains

array[string <hostname>] | null

required

When present, those domains will be available to provide as targets of custom redirection URLs generated by API to members

created_at

string <date-time>

read-onlyrequired

Time of record creation

Example:

2022-11-05T16:25:58.099512Z

updated_at

string <date-time>

read-onlyrequired

Time of the last record update

Example:

2022-11-15T16:25:58.099512Z

Example

{
  "application": {
    "identifier": "website",
    "name": "Website",
    "welcome_message": {
      "text": {
        "en": "Text"
      },
      "enabled": true
    },
    "optin_channels": [
      "fb_campaign_2018",
      "fb_campaign_2019"
    ],
    "enabled_properties": [
      "msisdn",
      "first_name"
    ],
    "required_properties": [
      "msisdn"
    ],
    "trusted_redirection_domains": [
      "example.com"
    ],
    "created_at": "2022-11-05T16:25:58.099512Z",
    "updated_at": "2022-11-15T16:25:58.099512Z"
  }
}

🟠404Record Not Found

🟠422Invalid Parameters