Opening lines

PATCH

/role/{roleId}/welcome

const url = 'https://api.harperharbor.com/open/v1/role/example/welcome';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"roleWelcome":"example","alternates":["example"],"prologue":["example"]}'
};

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

curl --request PATCH \
  --url https://api.harperharbor.com/open/v1/role/example/welcome \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "roleWelcome": "example", "alternates": [ "example" ], "prologue": [ "example" ] }'

alternates and prologue are full replacements: omit to keep, send [] to clear.

Authorizations

oauth

Parameters

Path Parameters

roleId

required

string

Request Body

application/json

object

roleWelcome

required

string

alternates

Array<string>

prologue

Array<string>

Example^generated

{
  "roleWelcome": "example",
  "alternates": [
    "example"
  ],
  "prologue": [
    "example"
  ]
}

Responses

200

Saved.