Playbook

Gets the details of the specified playbook.

get

Retrieves the details of the specified playbook.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Responses

200

namestring · nullableRequired

descriptionstring · nullableRequired

isPrivatebooleanRequired

organizationWidebooleanRequired

dateAddedstring · date-timeRequired

objectIdentifierstring · uuidRequired

hasImagebooleanOptional

403

Forbidden

404

Not Found

get/playbooks/{playbookIdentifier}

GET /playbooks/{playbookIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "description": "text",
  "isPrivate": true,
  "organizationWide": true,
  "metadata": [
    {
      "isYes": true,
      "decimalValue": 1,
      "text": "text",
      "date": "2026-07-10T20:27:12.163Z",
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "dateAdded": "2026-07-10T20:27:12.163Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "hasImage": true
}

Updates the specified playbook.

put

Updates the details of the specified playbook.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstring · uuidRequired

The identifier of the playbook to update.

Body

namestring · nullableRequired

descriptionstring · nullableRequired

isPrivatebooleanRequired

organizationWidebooleanRequired

Responses

200

namestring · nullableRequired

descriptionstring · nullableRequired

isPrivatebooleanRequired

organizationWidebooleanRequired

dateAddedstring · date-timeRequired

objectIdentifierstring · uuidRequired

hasImagebooleanOptional

400

Bad Request

403

Forbidden

404

Not Found

put/playbooks/{playbookIdentifier}

PUT /playbooks/{playbookIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 362

{
  "name": "text",
  "description": "text",
  "isPrivate": true,
  "organizationWide": true,
  "metadata": [
    {
      "isYes": true,
      "decimalValue": 1,
      "text": "text",
      "date": "2026-07-10T20:27:12.163Z",
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

{
  "name": "text",
  "description": "text",
  "isPrivate": true,
  "organizationWide": true,
  "metadata": [
    {
      "isYes": true,
      "decimalValue": 1,
      "text": "text",
      "date": "2026-07-10T20:27:12.163Z",
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "dateAdded": "2026-07-10T20:27:12.163Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "hasImage": true
}

Deletes the specified playbook.

delete

Deletes the specified playbook.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Responses

204

No Content

No content

403

Forbidden

404

Not Found

delete/playbooks/{playbookIdentifier}

DELETE /playbooks/{playbookIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Exports the specified playbook as a ZIP file.

get

Exports the specified playbook as a ZIP file.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstring · uuidRequired

The identifier of the playbook to export.

Responses

200

string · binaryOptional

400

Bad Request

403

Forbidden

404

Not Found

get/playbooks/{playbookIdentifier}/export

GET /playbooks/{playbookIdentifier}/export HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Clones the specified playbook.

post

Clones the specified playbook with a new name and description.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstring · uuidRequired

The identifier of the playbook to clone.

Body

namestring · nullableRequired

descriptionstring · nullableRequired

Responses

201

Created

namestring · nullableRequired

descriptionstring · nullableRequired

isPrivatebooleanRequired

organizationWidebooleanRequired

dateAddedstring · date-timeRequired

objectIdentifierstring · uuidRequired

hasImagebooleanOptional

400

Bad Request

403

Forbidden

404

Not Found

post/playbooks/{playbookIdentifier}/clone

POST /playbooks/{playbookIdentifier}/clone HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}

{
  "name": "text",
  "description": "text",
  "isPrivate": true,
  "organizationWide": true,
  "metadata": [
    {
      "isYes": true,
      "decimalValue": 1,
      "text": "text",
      "date": "2026-07-10T20:27:12.163Z",
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "dateAdded": "2026-07-10T20:27:12.163Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "hasImage": true
}

Gets the image for the specified playbook.

get

Retrieves the image file for the specified playbook.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstring · uuidRequired

The identifier of the playbook.

Responses

200

string · binaryOptional

403

Forbidden

404

Not Found

get/playbooks/{playbookIdentifier}/image

GET /playbooks/{playbookIdentifier}/image HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Adds an image to the specified playbook.

post

Uploads an image file to the specified playbook.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstring · uuidRequired

The identifier of the playbook.

Body

imagestring · binaryOptional

The image file to upload.

Responses

201

Created

No content

400

Bad Request

403

Forbidden

post/playbooks/{playbookIdentifier}/image

POST /playbooks/{playbookIdentifier}/image HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18

{
  "image": "binary"
}

No content

PreviousOrganization Metadata Options NextPlaybook Admin ACL

Last updated 11 months ago