> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Put Sale Stakeholder
> Updates the existing SaleStakeholder
NsApiSlow threshold: 1000 ms.
## OpenAPI
````yaml /openapi/rest/openapi-v3-SaleStakeholder.json put /api/v1/SaleStakeholder/{id}
openapi: 3.0.0
info:
version: v1-REST
title: SuperOffice REST API v1
description: SuperOffice REST API - SaleStakeholder
contact:
name: SuperOffice DevNet
url: https://docs.superoffice.com/en/api/index.html
email: sdk@superoffice.com
servers:
- url: http://localhost:56350
- url: https://localhost:56350
security: []
tags: []
externalDocs:
description: >-
The SuperOffice DevNet Community has more documentation, examples, and
discussion forums.
url: https://community.superoffice.com/en/developer/
paths:
/api/v1/SaleStakeholder/{id}:
put:
tags:
- SaleStakeholder
summary: Put Sale Stakeholder
description: |-
Updates the existing SaleStakeholder
NsApiSlow threshold: 1000 ms.
operationId: v1SaleStakeholder_PutSaleStakeholder
parameters:
- name: id
in: path
description: The SaleStakeholder id to update.
required: true
schema:
type: integer
format: int32
- name: $select
in: query
description: >-
Optional comma separated list of properties to include in the
result. Other fields are then nulled out to reduce payload size:
"Name,department,category" Default = show all fields.
required: false
schema:
type: string
- name: Accept-Language
in: header
description: >-
Convert string references and multi-language values into a specified
language (iso2) code.
required: false
schema:
type: string
- name: SO-Language
in: header
description: >-
Convert string references and multi-language values into a specified
language (iso2) code. Overrides Accept-Language value.
required: false
schema:
type: string
- name: SO-Culture
in: header
description: >-
Number, date formatting in a specified culture (iso2 language) code.
Partially overrides SO-Language/Accept-Language value. Ignored if no
Language set.
required: false
schema:
type: string
- name: SO-TimeZone
in: header
description: >-
Specify the timezone code that you would like date/time responses
converted to.
required: false
schema:
type: string
- name: SO-AppToken
in: header
description: >-
The application token that identifies the partner app. Used when
calling Online WebAPI from a server.
required: false
schema:
type: string
requestBody:
$ref: '#/components/requestBodies/SuperOffice.CRM.Services.SaleStakeholder'
responses:
'200':
description: SaleStakeholder updated.
content:
application/json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.SaleStakeholderWithLinks
text/json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.SaleStakeholderWithLinks
application/xml:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.SaleStakeholderWithLinks
text/xml:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.SaleStakeholderWithLinks
application/json-patch+json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.SaleStakeholderWithLinks
application/merge-patch+json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.SaleCarriers.SaleStakeholderWithLinks
'400':
description: Bad request. Entity to save is not in request body.
security:
- SuperOffice_Password: []
SuperId_Authentication: []
components:
requestBodies:
SuperOffice.CRM.Services.SaleStakeholder:
content:
application/json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.SaleStakeholder'
text/json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.SaleStakeholder'
application/xml:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.SaleStakeholder'
text/xml:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.SaleStakeholder'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.SaleStakeholder'
application/json-patch+json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.SaleStakeholder'
application/merge-patch+json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.SaleStakeholder'
description: The SaleStakeholder to be saved.
required: true
schemas:
SuperOffice.WebApi.v1.Carriers.SaleCarriers.SaleStakeholderWithLinks:
description: "\r\n SaleStakeholder entity with API _Links added."
type: object
properties:
StakeholderRoleName:
description: Stakeholder role name
type: string
Comment:
description: Optional comment text
type: string
StakeholderRoleId:
format: int32
description: Stakeholde role list id - Primary key
type: integer
CountryId:
format: int32
description: Country id - primary key
type: integer
PersonId:
format: int32
description: Person id - Primary key
type: integer
EmailDescription:
description: E-mail description
type: string
EmailId:
format: int32
description: E-mail address id - Primary key
type: integer
EmailAddress:
description: E-mail address
type: string
PhoneId:
format: int32
description: Primary key
type: integer
ContactName:
description: Contact name
type: string
ContactId:
format: int32
description: Contact ID of person or contact who is the sale stakeholder
type: integer
SaleId:
format: int32
description: Parent sale
type: integer
Mrmrs:
description: e.g. Mrs, Mr, Ms, Dr.
type: string
Firstname:
description: First name
type: string
MiddleName:
description: Middle name or 'van' etc.
type: string
Lastname:
description: Last name
type: string
SaleStakeholderId:
format: int32
description: Primary key
type: integer
Rank:
format: int32
description: Rank in list of stakeholders
type: integer
Phone:
description: Phone number
type: string
TableRight:
$ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
FieldProperties:
description: >-
Field property dictionary mapping field names to field access
rights.
type: object
additionalProperties:
$ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
_Links:
type: object
additionalProperties:
type: string
SuperOffice.CRM.Services.SaleStakeholder:
description: "Carrier object for SaleStakeholder.\r\nServices for the SaleStakeholder Carrier is available from the Sale Agent."
type: object
properties:
StakeholderRoleName:
description: Stakeholder role name
type: string
Comment:
description: Optional comment text
type: string
StakeholderRoleId:
format: int32
description: Stakeholde role list id - Primary key
type: integer
CountryId:
format: int32
description: Country id - primary key
type: integer
PersonId:
format: int32
description: Person id - Primary key
type: integer
EmailDescription:
description: E-mail description
type: string
EmailId:
format: int32
description: E-mail address id - Primary key
type: integer
EmailAddress:
description: E-mail address
type: string
PhoneId:
format: int32
description: Primary key
type: integer
ContactName:
description: Contact name
type: string
ContactId:
format: int32
description: Contact ID of person or contact who is the sale stakeholder
type: integer
SaleId:
format: int32
description: Parent sale
type: integer
Mrmrs:
description: e.g. Mrs, Mr, Ms, Dr.
type: string
Firstname:
description: First name
type: string
MiddleName:
description: Middle name or 'van' etc.
type: string
Lastname:
description: Last name
type: string
SaleStakeholderId:
format: int32
description: Primary key
type: integer
Rank:
format: int32
description: Rank in list of stakeholders
type: integer
Phone:
description: Phone number
type: string
TableRight:
$ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
FieldProperties:
description: >-
Field property dictionary mapping field names to field access
rights.
type: object
additionalProperties:
$ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
SuperOffice.CRM.Security.TableRight:
description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
type: object
properties:
Mask:
type: string
Reason:
type: string
SuperOffice.CRM.Security.FieldProperty:
description: >-
Class holding properties like field length, field type about a field in
the carrier.
type: object
properties:
FieldRight:
$ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
FieldType:
type: string
FieldLength:
format: int32
description: ''
type: integer
SuperOffice.CRM.Security.FieldRight:
description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
type: object
properties:
Mask:
type: string
Reason:
type: string
````
## Related topics
- [Stakeholders](/en/sale/learn/stakeholders/index.md)
- [Put Sale Type Entity](/en/api/reference/restful/rest/list_saletype/put-sale-type-entity.md)
- [Put Sale Entity](/en/api/reference/restful/rest/sale/put-sale-entity.md)
- [Add Sale Stakeholders](/en/api/reference/restful/agent/sale_agent/add-sale-stakeholders.md)
- [Update Sale Stakeholders](/en/api/reference/restful/agent/sale_agent/update-sale-stakeholders.md)