Create settings

POST

/api/managing-entity/{managingEntityIdentifier}/studio/managed-social/settings

const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/managed-social/settings';
const options = {
  method: 'POST',
  headers: {
    'Wink-Version': '2.0',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"customizationIdentifier":"","tones":["NEUTRAL"],"postTypes":["TRANSACTIONAL"],"autoApprove":false,"notificationEmail":"","notificationName":"","targets":[""],"creators":[""],"placeId":""}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/managed-social/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "customizationIdentifier": "", "tones": [ "NEUTRAL" ], "postTypes": [ "TRANSACTIONAL" ], "autoApprove": false, "notificationEmail": "", "notificationName": "", "targets": [ "" ], "creators": [ "" ], "placeId": "" }'

Creates the initial managed-social settings for the managing entity and returns the persisted configuration.

Authorizations

oauth2ClientCredentials

Parameters

Path Parameters

managingEntityIdentifier

required

string

Create settings for this managing entity

Example

d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

Initial managed social settings configuration

application/json

object

customizationIdentifier

required

Customization identifier

string format: uuid

"" >= 1 characters

Example

customization-1

tones

Array<object>

Choose the tone of voice to use in text creation.

object

type

required

The tone of voice to use in text creation.

string

Allowed values: NEUTRAL FRIENDLY LUXURY FOODIE ADVENTUROUS FAMILY ROMANTIC HUMOROUS ECO LOCAL_INSIDER INCLUSIVE BUDGET

priority

required

The weight / importance of this tone.

integer format: int32

Example

NEUTRAL

postTypes

Array<object>

Choose the post type preferences.

object

type

required

The post type preference.

string

Allowed values: TRANSACTIONAL AWARENESS SENTIMENT

priority

required

The weight / importance of this post type.

integer format: int32

Example

TRANSACTIONAL

autoApprove

Whether to approve posts and publish automatically.

boolean

Example

true

notificationEmail

required

The email address to send post approval reminders.

string format: email

"" >= 1 characters

Example

[email protected]

notificationName

required

The name of the email address holder.

string

"" >= 1 characters

Example

Hotel X

targets

Array<object>

When to post and which language to post in.

object

language

required

The languages to post in.

string

"" >= 1 characters

timezone

required

string

>= 1 characters

creators

Array<object>

Lets the subscriber choose which content creators get used.

object

type

required

Lets the subscriber choose which persona gets used.

string

Allowed values: ACTIVITY ADD_ON ATTRACTION FUNNY MEETING_ROOM PLACE PROPERTY ROOM_TYPE RESTAURANT SPA DESTINATION_RELATED USER_SENTIMENT

priority

required

They weight / importance of this type.

integer format: int32

placeId

Google Business account ID

string

Example

google-place-1

Responses

201

Created

application/json

object

Document UUID

string format: uuid

createdDate

Datetime this record was first created

string format: date-time

lastUpdate

Datetime this record was last updated

string format: date-time

version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64

userIdentifier

required

The user ID that owns the account

string format: uuid

"" >= 1 characters

ownerIdentifier

required

The owner entity this entry associates with

string format: uuid

"" >= 1 characters

customizationIdentifier

required

Customization identifier

string format: uuid

"" >= 1 characters

placeId

Google Place ID

string

notificationEmail

required

The email address to send post approval reminders.

string format: email

"" >= 1 characters

notificationName

required

The name of the email address holder.

string

"" >= 1 characters

tones

required

Array<object>

>= 1 items

Choose the tone of voice to use in text creation.

object

type

required

The tone of voice to use in text creation.

string

Allowed values: NEUTRAL FRIENDLY LUXURY FOODIE ADVENTUROUS FAMILY ROMANTIC HUMOROUS ECO LOCAL_INSIDER INCLUSIVE BUDGET

priority

required

The weight / importance of this tone.

integer format: int32

postTypes

required

Array<object>

>= 1 items

Choose the post type preferences.

object

type

required

The post type preference.

string

Allowed values: TRANSACTIONAL AWARENESS SENTIMENT

priority

required

The weight / importance of this post type.

integer format: int32

autoApprove

Whether to approve posts and publish automatically.

boolean

connections

Array<object>

Social network consent entries

object

platform

required

The social network platform

string

Allowed values: WINK_LINKS FACEBOOK INSTAGRAM

status

required

Current connection status

string

Allowed values: ACTIVE DISCONNECTED SUSPENDED

subAccounts

Array<object>

Sub-accounts (pages, profiles) available through this connection

object

required

Platform-specific identifier for this sub-account (page, profile, etc)

string

"" >= 1 characters

name

required

Display name of the sub-account

string

"" >= 1 characters

selected

Whether this sub-account is currently selected for posting

boolean

targets

required

Array<object>

When to post and which language to post in.

object

language

required

The languages to post in.

string

"" >= 1 characters

timezone

required

string

>= 1 characters

creators

required

Array<object>

Lets the subscriber choose which content creators get used.

object

type

required

Lets the subscriber choose which persona gets used.

string

Allowed values: ACTIVITY ADD_ON ATTRACTION FUNNY MEETING_ROOM PLACE PROPERTY ROOM_TYPE RESTAURANT SPA DESTINATION_RELATED USER_SENTIMENT

priority

required

They weight / importance of this type.

integer format: int32

Example

{
  "id": "",
  "createdDate": "",
  "lastUpdate": "",
  "version": "",
  "userIdentifier": "",
  "ownerIdentifier": "",
  "customizationIdentifier": "",
  "placeId": "",
  "notificationEmail": "",
  "notificationName": "",
  "tones": [
    "NEUTRAL"
  ],
  "postTypes": [
    "TRANSACTIONAL"
  ],
  "autoApprove": false,
  "connections": [
    ""
  ],
  "targets": [
    ""
  ],
  "creators": [
    ""
  ]
}

400

Bad Request

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Unauthorized

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

Forbidden

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

500

Internal Server Error

object

Example ^generated

{}

Create settings

Authorizations

Parameters

Path Parameters

Example

Header Parameters

Request Body required

Example

Example

Example

Example

Example

Example

Example

Responses

201

Example

400

Example generated

401

403

500

Example generated

Request Body^required

Example ^generated

Example ^generated