> ## 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.

# Save C R M Script By Unique Identifier

> Create or Update the CRMScript information

<para />## Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered.



## OpenAPI

````yaml /openapi/rest/openapi-v3-Script.json put /api/v1/Script/{uniqueIdentifier}
openapi: 3.0.0
info:
  version: v1-REST
  title: SuperOffice REST API v1
  description: SuperOffice REST API - Script
  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/Script/{uniqueIdentifier}:
    put:
      tags:
        - Script
      summary: Save C R M Script By Unique Identifier
      description: >-
        Create or Update the CRMScript information


        <para />## Online Restricted: ## The CRMScript agent is not available in
        Online by default. Access must be requested specifically when app is
        registered.
      operationId: v1Script_SaveCRMScriptByUniqueIdentifier
      parameters:
        - name: uniqueIdentifier
          in: path
          description: Global unique reference to script (independent of installation)
          required: true
          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:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
          text/json:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
          application/xml:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
          text/xml:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
        description: Information about the CRMScript
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.Script'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.Script:
      description: "The Script Service. The service implements all services working with the CRMScript object without reference to primary keys. Primarily used by VSCode integration.\r\n<para />\r\nCarrier object for Script.\r\nServices for the Script Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.ICRMScriptAgent\">CRMScript Agent</see>."
      type: object
      properties:
        UniqueIdentifier:
          description: Global unique identifier, accross customers/tenants
          type: string
        Name:
          description: A description of this script
          type: string
        Description:
          description: Optional description of what this script is used for.
          type: string
        IncludeId:
          description: A unique name used for including this script in another
          type: string
        Source:
          description: The script
          type: string
        Registered:
          format: date-time
          description: Registered when  in UTC.
          type: string
        RegisteredBy:
          description: Who created this script
          type: string
        Updated:
          format: date-time
          description: Last updated when  in UTC.
          type: string
        UpdatedBy:
          description: Who updated this script
          type: string
        Path:
          description: Path to script in the hierarchy.
          type: string
        BlockedVerbs:
          description: The verbs that are blocked when calling a ejscript over HTTP
          enum:
            - BlockNone
            - BlockGET
            - BlockPOST
            - BlockPUT
            - BlockDELETE
            - BlockPATCH
            - BlockOPTIONS
            - BlockHEAD
            - BlockTRACE
            - BlockCONNECT
            - BlockOTHER
            - BlockAll
          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

- [Save C R M Script By Unique Identifier](/en/api/reference/restful/agent/crmscript_agent/save-c-r-m-script-by-unique-identifier.md)
- [SuperOffice.WebApi.Data.CRMScript SaveCRMScriptByUniqueIdentifierRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.CRMScript_SaveCRMScriptByUniqueIdentifierRequest.md)
- [Delete C R M Script By Unique Identifier](/en/api/reference/restful/agent/crmscript_agent/delete-c-r-m-script-by-unique-identifier.md)
- [Get C R M Script By Unique Identifier](/en/api/reference/restful/rest/script/get-c-r-m-script-by-unique-identifier.md)
