Compilable
/
Retrieve the specified compilable

NP6 API Reference (8.1.0)

This documentation provides comprehensive access to the full range of functionalities offered by the NP6 platform through a standardized RESTful interface.

If you have any questions or need assistance, please contact our support team at https://support.chapsvision.com.

Languages
Servers
Production server
https://api-cm.np6.com/

Good to know

Email & SMS

Operations

Notification

Operations

Archives

Operations

Email & SMS

Operations

Notification

Operations

Display

Operations

Email & SMS

Operations

Notification

Operations

Workflow

Operations

Campaign

Operations

Campaign

Operations

Contact

Operations

Field

Operations

Enumeration

Operations

Segment

Operations

Import

Operations

Subscription

Operations

Contact

Operations

Webtask

Operations

Compilable

Operations

Create a compilable

Request

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

Bodyapplication/json

Data used to create the compilable

idstring(uuid)

Defines the unique id of the compilable

namestring

Defines the name of the compilable

descriptionstring

Defines the description of the compilable

statestring

Defines the state of the compilable

stampobject

Defines the stamp informations of the compilable

creationstring(date-time)

Defines a date, used to store the creation date of a related data

modificationstring(date-time)

Defines a date, used to store the last modification date of a related data

valueobject

Defines the underlying scriptable value describing the compilable

typestring
Discriminator
sourceobject

Defines the underlying data source

cursorsArray of objects

Defines a list of transformation cursors

parametersArray of objects

Defines a list of expected parameters

previewobject

Defines arguments used to preview the compilable

returnsobject

Defines the expected type of the return value

curl -i -X POST \
  https://api-cm.np6.com/scripting/compilables \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "state": "string",
    "stamp": {
      "creation": "2019-08-24T14:15:22Z",
      "modification": "2019-08-24T14:15:22Z"
    },
    "value": {
      "type": "string"
    }
  }'

Responses

The created compilable

Bodyapplication/json
idstring(uuid)

Defines the unique id of the compilable

namestring

Defines the name of the compilable

descriptionstring

Defines the description of the compilable

statestring

Defines the state of the compilable

stampobject

Defines the stamp informations of the compilable

creationstring(date-time)

Defines a date, used to store the creation date of a related data

modificationstring(date-time)

Defines a date, used to store the last modification date of a related data

valueobject

Defines the underlying scriptable value describing the compilable

typestring
Discriminator
sourceobject

Defines the underlying data source

cursorsArray of objects

Defines a list of transformation cursors

parametersArray of objects

Defines a list of expected parameters

previewobject

Defines arguments used to preview the compilable

returnsobject

Defines the expected type of the return value

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "state": "string",
  "stamp": {
    "creation": "2019-08-24T14:15:22Z",
    "modification": "2019-08-24T14:15:22Z"
  },
  "value": {
    "type": "string"
  }
}

Retrieve the specified compilable

Request

Path
idstring(uuid)required

The compilable's id to get

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

curl -i -X GET \
  'https://api-cm.np6.com/scripting/compilables/{id}' \
  -H 'X-Key: string'

Responses

A compilable

Bodyapplication/json
idstring(uuid)

Defines the unique id of the compilable

namestring

Defines the name of the compilable

descriptionstring

Defines the description of the compilable

statestring

Defines the state of the compilable

stampobject

Defines the stamp informations of the compilable

creationstring(date-time)

Defines a date, used to store the creation date of a related data

modificationstring(date-time)

Defines a date, used to store the last modification date of a related data

valueobject

Defines the underlying scriptable value describing the compilable

typestring
Discriminator
sourceobject

Defines the underlying data source

cursorsArray of objects

Defines a list of transformation cursors

parametersArray of objects

Defines a list of expected parameters

previewobject

Defines arguments used to preview the compilable

returnsobject

Defines the expected type of the return value

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "state": "string",
  "stamp": {
    "creation": "2019-08-24T14:15:22Z",
    "modification": "2019-08-24T14:15:22Z"
  },
  "value": {
    "type": "string"
  }
}

Update a compilable

Request

Path
idstring(uuid)required

The compilable's id to update

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

Bodyapplication/json

Data used to update the compilable

idstring(uuid)

Defines the unique id of the compilable

namestring

Defines the name of the compilable

descriptionstring

Defines the description of the compilable

statestring

Defines the state of the compilable

stampobject

Defines the stamp informations of the compilable

creationstring(date-time)

Defines a date, used to store the creation date of a related data

modificationstring(date-time)

Defines a date, used to store the last modification date of a related data

valueobject

Defines the underlying scriptable value describing the compilable

typestring
Discriminator
sourceobject

Defines the underlying data source

cursorsArray of objects

Defines a list of transformation cursors

parametersArray of objects

Defines a list of expected parameters

previewobject

Defines arguments used to preview the compilable

returnsobject

Defines the expected type of the return value

curl -i -X PUT \
  'https://api-cm.np6.com/scripting/compilables/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "state": "string",
    "stamp": {
      "creation": "2019-08-24T14:15:22Z",
      "modification": "2019-08-24T14:15:22Z"
    },
    "value": {
      "type": "string"
    }
  }'

Responses

The updated compilable

Bodyapplication/json
idstring(uuid)

Defines the unique id of the compilable

namestring

Defines the name of the compilable

descriptionstring

Defines the description of the compilable

statestring

Defines the state of the compilable

stampobject

Defines the stamp informations of the compilable

creationstring(date-time)

Defines a date, used to store the creation date of a related data

modificationstring(date-time)

Defines a date, used to store the last modification date of a related data

valueobject

Defines the underlying scriptable value describing the compilable

typestring
Discriminator
sourceobject

Defines the underlying data source

cursorsArray of objects

Defines a list of transformation cursors

parametersArray of objects

Defines a list of expected parameters

previewobject

Defines arguments used to preview the compilable

returnsobject

Defines the expected type of the return value

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "state": "string",
  "stamp": {
    "creation": "2019-08-24T14:15:22Z",
    "modification": "2019-08-24T14:15:22Z"
  },
  "value": {
    "type": "string"
  }
}

Mobile Application

Operations

Category

Operations

Marketing Pressure

Operations
© 2025 - ChapsVision - All Rights Reserved.