KIO Link
KIO Link XC API
KIO Link APIKIO BMSHuawei BMSHuawei Alert
KIO Link XC API
KIO Link APIKIO BMSHuawei BMSHuawei Alert
  1. XC Contract Setting Participants
  • DocuSign
    • Overview
    • List a XC request's DocuSign envelopes
      GET
    • Get an embeded URL signature for a XC Request
      GET
    • Regenerate a URL signature for the current signer
      GET
    • List the order of signers of a DocuSign Envelope
      GET
    • Create a DocuSign envelope for a XC request
      POST
    • Resend email & recover URL signature for a XC request
      POST
    • Create a DocuSign envelope for multiple signers
      POST
  • XC Client Prices
    • Overview
    • List XC client prices
      GET
    • Get a XC client's price
      GET
    • Create a XC client's price
      POST
    • Update a XC client's price
      PATCH
    • Delete a XC client's price
      DELETE
  • XC Comments
    • Overview
    • List XC comments
      GET
    • Get a XC comment
      GET
    • Create a XC comment
      POST
    • Update a XC comment
      PATCH
    • Delete a XC comment
      DELETE
  • XC Connections
    • Overview
    • List XC connections
    • Get a XC connection
    • Create a XC connection
    • Update a XC connection
    • Delete a XC connection
  • XC Contract Settings
    • Overview
    • List XC contract settings
    • Get a XC contract setting
    • Get a XC Request's contract setting
    • Create a XC contract setting
    • Update a XC contract setting
    • Delete a XC contract setting
  • XC Contract Setting Participants
    • Overview
    • List all XC contract settings participants
      GET
    • List a XC contract settings participants
      GET
    • Get a XC contract settings participant
      GET
    • Create a XC contract settings participant
      POST
    • Update a XC contract settings participant
      PATCH
    • Delete a XC contract settings participant
      DELETE
  • XC Data Centers
    • Overview
    • List XC datacenters
    • Create a XC datacenter
    • Update a XC datacenter
    • Delete a XC datacenter
  • XC Documents
    • Overview
    • List XC documents
    • Get a XC document's metadata
    • Get a XC document download URL
    • Get a XC document binary file
    • Upload a XC document
    • Delete a XC document
  • XC Reports
    • Overview
    • Download XC requests report
    • Download XC satisfaction survey report
    • Download XC connections report
  • XC Requests
    • Overview
    • List XC requests
    • Get a XC request
    • Get a XC request (complete details)
    • Create a XC request
    • Upsert a XC request draft
    • Update a XC request's general data
    • Change a XC request's status
    • Delete a XC request
    • Revert a XC request to Revision
  • XC Salesforce
    • Overview
    • Accounts
      • Overview
      • List accounts
      • Get an account
    • Opportunities
      • Overview
      • Attachments
        • Overview
        • List opportunity attachments
        • Upload an opportunity attachment
        • Download an opportunity file
      • List opportunities
      • Get an opportunity
      • Create an opportunity
      • Update an opportunity
    • Products
      • Overview
      • List products
      • Get a product
    • Project Requests
      • Overview
      • List project requests
      • Get a project request
      • Create a project request
      • Update a project request
    • Users
      • Overview
      • List users
      • Get a user
    • XC/IC Requests
      • Overview
      • Attachments
        • Overview
        • List XC/IC attachments
        • Upload a XC/IC attachment
        • Download a XC/IC file
      • List XC/IC requests
      • List all KIO Link connections from Salesforce XC/IC requests
      • Get a XC/IC request
      • Create a XC/IC request
      • Update a XC/IC request
  • XC Satisfaction Survey
    • Overview
    • List XC satisfaction surveys
    • Get a XC satisfaction survey
    • Get a XC satisfaction survey per user
    • Create XC satisfaction survey
  • XC Statuses
    • Overview
    • List XC statuses
    • Get a XC status
    • Create a XC status
    • Update a XC status
    • Delete a XC status
  • XC Status Histories
    • Overview
    • List XC status histories
    • List XC status history time summary
    • Get a XC status history record
  • Schemas
    • DocuSign
      • DocuSign Envelope Signer
      • DocuSign Signing URL Result
      • DocuSign Signer Routing
      • DocuSign Resend Result
      • DocuSign Envelope
    • XC Client Prices
      • XC Client Price
    • XC Comments
      • XC Comment
    • XC Connections
      • XC Connection
    • XC Contract Settings
      • XC Contract Setting
    • XC Contract Setting Participants
      • XC Contract Setting Participant
    • XC Data Centers
      • XC Datacenter
    • XC Documents
      • XC Document
    • XC Requests
      • XC Request With Relations
      • XC Request List Item
      • XC Request
      • XC Request With Details
    • XC Salesforce
      • Salesforce Connection
      • Salesforce Account
      • Salesforce User
      • Salesforce Product
      • Salesforce Opportunity List Item
      • Salesforce Opportunity
      • Salesforce Opportunity Write Result
      • Salesforce Attachment
      • Salesforce Attachment Upload Result
      • Salesforce Attachment Download Result
      • Salesforce Request List Item
      • Salesforce Request Point
      • Salesforce Request
      • Salesforce Request Write Result
      • Salesforce Project Request
      • Salesforce Project Request Write Result
      • Salesforce Quote
      • Salesforce Quote Line
    • XC Satisfaction Surveys
      • XC Satisfaction Survey
    • XC Statuses
      • XC Status
    • XC Status Histories
      • XC Status Time
      • XC Status Stage Time
      • XC Status History
    • Error
    • Date Metadata
    • Pagination Metadata
  1. XC Contract Setting Participants

Overview

XC Contract Setting Participants#

CRUD endpoints for the people (participants) listed on a contract setting's generated documents — e.g. signers or stakeholders named on the SOW/Acta for an XC request.

Concepts#

Belongs to a contract setting: every participant is linked to exactly one XC Contract Setting via contract_setting_id, which must reference an existing record.
Required fields: name and email are required on create; role, company_name, and business_name are optional free-text fields.
Two ways to list: a flat, project-wide list (GET /xc/contract-setting-participants, filterable by contract_setting_id and/or email) and a scoped list nested under a specific contract setting (GET /xc/contract-settings/{id}/participants, using the same filters/sorting/pagination).
Two ways to create: nested under a contract setting (POST /xc/contract-settings/{id}/participants, where contract_setting_id is taken from the path) or flat (POST /xc/contract-setting-participants, where contract_setting_id must be supplied in the body).
Reassignable: PATCH can move a participant to a different contract setting by passing a new (existing) contract_setting_id.

Endpoints#

List all XC contract settings participants#

GET /v1/xc/contract-setting-participants
Project-wide paginated list, optionally filtered by contract_setting_id and/or email.

List a XC contract settings participants#

GET /v1/xc/contract-settings/{id}/participants
Same listing, scoped to one contract setting.

Create a XC contract settings participant#

POST /v1/xc/contract-settings/{id}/participants
Adds a participant to the contract setting in the path.

Get a XC contract settings participant#

GET /v1/xc/contract-setting-participants/{id}
Returns a single participant by its own ID.

Update a XC contract settings participant#

PATCH /v1/xc/contract-setting-participants/{id}
Updates one or more fields, optionally reassigning the participant to another contract setting.

Delete a XC contract settings participant#

DELETE /v1/xc/contract-setting-participants/{id}
Permanently deletes a participant.

Source#

Router: routes/v1/xc/contract-setting-participants.router.js
Controller: controllers/xc/contract-setting-participants.controller.js
Service: services/xc/contract-setting-participants.service.js
Entity: entities/xc-contract-setting-participant.js
Modified at 2026-09-25 18:12:32
Previous
Delete a XC contract setting
Next
List all XC contract settings participants
Built with