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

# Execute Script By Unique Id

> Execute a CRMScript with parameters, returning printed output value.

<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-CRMScript.json post /api/v1/CRMScript/{cRMScriptUniqueId}/Execute
openapi: 3.0.0
info:
  version: v1-REST
  title: SuperOffice REST API v1
  description: SuperOffice REST API - CRMScript
  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/CRMScript/{cRMScriptUniqueId}/Execute:
    post:
      tags:
        - CRMScript
      summary: Execute Script By Unique Id
      description: >-
        Execute a CRMScript with parameters, returning printed output value.


        <para />## Online Restricted: ## The CRMScript agent is not available in
        Online by default. Access must be requested specifically when app is
        registered.
      operationId: v1CRMScriptEntity_ExecuteScriptByUniqueId
      parameters:
        - name: cRMScriptUniqueId
          in: path
          description: The unique id of the CRMScript to validate
          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:
        $ref: '#/components/requestBodies/v1CRMScriptEntity_ExecuteScriptParameters'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
            text/xml:
              schema:
                type: string
            application/json-patch+json:
              schema:
                type: string
            application/merge-patch+json:
              schema:
                type: string
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  requestBodies:
    v1CRMScriptEntity_ExecuteScriptParameters:
      content:
        application/json:
          schema:
            type: object
            additionalProperties:
              type: string
        text/json:
          schema:
            type: object
            additionalProperties:
              type: string
        application/xml:
          schema:
            type: object
            additionalProperties:
              type: string
        text/xml:
          schema:
            type: object
            additionalProperties:
              type: string
        application/x-www-form-urlencoded:
          schema:
            type: object
            additionalProperties:
              type: string
        application/json-patch+json:
          schema:
            type: object
            additionalProperties:
              type: string
        application/merge-patch+json:
          schema:
            type: object
            additionalProperties:
              type: string
      description: Parameters passed as variables to the CRMScript
      required: true

````

## Related topics

- [Execute Script By Unique Id](/en/api/reference/restful/agent/crmscript_agent/execute-script-by-unique-id.md)
- [SuperOffice.WebApi.Data.CRMScript ExecuteScriptByUniqueIdRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.CRMScript_ExecuteScriptByUniqueIdRequest.md)
- [SuperOffice.WebApi.Agents.ICRMScriptAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ICRMScriptAgent.md)
- [SuperOffice.WebApi.Agents.CRMScriptAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.CRMScriptAgent.md)
- [Execute Script As Event By Unique Id](/en/api/reference/restful/rest/crmscript/execute-script-as-event-by-unique-id.md)