Create Participant

Add new chat participants

post

When a single participant is added, returns a single participant entity. For multiple, returns a list.

Path parameters

chatIdstringRequired

The chat ID.

Bodyobject[]

application/jsontext/jsonapplication/*+json

pathstringOptional

isDefinedbooleanRead-onlyOptional

Responses

201

Created

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

post

/public/v1/helpdesk/chats/{chatId}/participants

HTTPcURLJavaScriptPython

POST /public/v1/helpdesk/chats/{chatId}/participants HTTP/1.1
Host: api.s1.show
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  {
    "node": {
      "name": "text"
    },
    "path": "text"
  }
]

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-03-30T20:13:12.706Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-03-30T20:13:12.706Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "exited": {
      "at": "2026-03-30T20:13:12.706Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "reactivated": {
      "at": "2026-03-30T20:13:12.706Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "chat": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Direct"
  },
  "contact": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-03-30T20:13:12.706Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-03-30T20:13:12.706Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "revision": 1,
    "name": "text",
    "blockedReason": "text",
    "email": "text",
    "status": "text",
    "identity": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-03-30T20:13:12.706Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-03-30T20:13:12.706Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "directories": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-03-30T20:13:12.706Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-03-30T20:13:12.706Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "revision": 1,
        "account": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-03-30T20:13:12.706Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-03-30T20:13:12.706Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "text",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          },
          "defaultLanguageCode": "text"
        },
        "origin": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-03-30T20:13:12.706Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-03-30T20:13:12.706Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "text",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          },
          "defaultLanguageCode": "text"
        },
        "type": "text",
        "contacts": [
          "[Circular Reference]"
        ]
      }
    ],
    "chat": true
  },
  "identity": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "muted": true,
  "status": "Active",
  "lastReadMessage": {
    "id": "text",
    "revision": 1,
    "content": "text",
    "visibility": "Public",
    "isDeleted": true
  },
  "unreadMessageCount": 1
}