---
title: "Customize welcome message"
url: "https://docs.signnow.com/docs/document-field-invite/operations/post-v2-signing-session-settings"
type: "endpoint"
section: "document-field-invite"
slug: "document-field-invite/operations/post-v2-signing-session-settings"
method: "POST"
path: "/v2/signing-session-settings"
operation_id: "post-v2-signing-session-settings"
authorization: "bearer"
---

# Customize welcome message

`POST /v2/signing-session-settings`

This endpoint allows API users to add a welcome message to field invites sent from this application. The welcome message appears when a signer clicks the welcome message button in the signing session.

<img src="/reference-assets/images/Screenshots with attribute explanations/welcome_message.png" alt="Welcome message example">

**Notes**

* Each user can have one welcome message. To replace it, reset it with [Reset welcome message to default](/docs/document-field-invite/operations/delete-v2-signing-session-settings) first.

## Authorization

bearer

## Header Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `Content-Type` | string | No | application/json |

## Request Body

**Schema**

```json
{
  "type": "object",
  "required": [
    "welcome_message"
  ],
  "properties": {
    "welcome_message": {
      "type": "string",
      "description": "Text of the welcome message. Min: `3`, Max: `200` characters. Allowed characters: letters `A-Z` and `a-z`, digits `0-9`, plain brackets `()`, dot `.`, dash `-`, space and comma `,`."
    }
  },
  "x-examples": {
    "Set welcome message": {
      "welcome_message": "Hi, please review and sign this document."
    }
  }
}
```

**Example** (`Set welcome message`)

```json
{
  "welcome_message": "Hi, please review and sign this document."
}
```

## Responses

### 201

The welcome message has been saved. The response body is empty.

### 400

- Request with any of cases:

    - incorrect token of user
    - expired token of user
    - empty header
    - authorization = null
    - authorization without value
- Setting already exists
- `welcome_message` not received	
- `welcome_message` received with empty value
- `welcome_message` is not received as a string (it received like array or integer, etc.)
- `welcome_message` value contains less than 3 symbols
- `welcome_message` value contains more than 200 symbols
- `welcome_message` value contains incorrect symbol(s)


**Example** (`Incorrect access token`)

```json
{
  "code": 1537,
  "message": "invalid_token"
}
```

**Example** (`Setting already exists`)

```json
{
  "errors": [
    {
      "code": 65536,
      "message": "Signing session setting already exists"
    }
  ]
}
```

**Example** (``welcome_message` < 3 symbols`)

```json
{
  "errors": [
    {
      "code": 0,
      "message": "`welcome_message` must be at least 3 characters long."
    }
  ]
}
```

**Example** (`welcome_message > 200 symbols`)

```json
{
  "errors": [
    {
      "code": 0,
      "message": "`welcome_message` cannot be longer than 200 characters."
    }
  ]
}
```

**Example** (``welcome_message` isn't string`)

```json
{
  "errors": [
    {
      "code": 0,
      "message": "`welcome_message` field data must be a string"
    }
  ]
}
```

**Example** (``welcome_message` not received.`)

```json
{
  "errors": [
    {
      "code": 0,
      "message": "`welcome_message` field is required"
    }
  ]
}
```

**Example** (``welcome_message` with empty value`)

```json
{
  "errors": [
    {
      "code": 0,
      "message": "`welcome_message` must not be empty"
    }
  ]
}
```

**Example** (`welcome_message with incorrect symbol(s)`)

```json
{
  "errors": [
    {
      "code": 0,
      "message": "Unsupported symbol was met. Allowed symbols: A-Z, a-z, 0-9, plain brackets '()', dot '.', dash '-', space ' ' and comma ','"
    }
  ]
}
```

## Code Examples

> Replace `$SIGNNOW_ACCESS_TOKEN` and any `{placeholder}` values before running.

### cURL

```bash
curl -X POST \
  "https://api.signnow.com/v2/signing-session-settings" \
  -H "Authorization: Bearer $SIGNNOW_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"welcome_message": "Hi, please review and sign this document."}'
```

---
*Full reference: https://docs.signnow.com/docs/document-field-invite/operations/post-v2-signing-session-settings*