GEgetfrontline
Max Playbooks

Update a Max playbook

Changed on

Updates a playbook's name, instructions, or enabled state. Only the fields you send are changed. Requires a USER API key.

patch/public/v1/max/playbooks/{playbookId}

Request

Path parameters

playbookIdinteger nullable
Example:42

Request body

namestring
descriptionstring
instructionsstring
toolsstring[]
visibility'PRIVATE' | 'ACCOUNT'
isActiveboolean
integrationsstring[]
appliesToAllAccountsboolean
connectedAccountIdsinteger[]

Example request

{
  "name": "example",
  "description": "example",
  "instructions": "example value",
  "tools": [
    "example"
  ],
  "visibility": "PRIVATE",
  "integrations": [
    "GMAIL"
  ],
  "selectedRecordTypes": [
    {
      "recordTypeId": 1
    }
  ],
  "selectedCustomTools": [
    {
      "id": 1
    }
  ],
  "connectedAccountIds": [
    1
  ]
}

Response

Updated playbook

oktrue required

Example response

{
  "ok": true,
  "data": {
    "id": 1,
    "name": "example",
    "description": "example",
    "type": "AUTO_DRAFTING",
    "instructions": "example",
    "tools": [
      "example"
    ],
    "attachments": [
      {
        "id": 1,
        "name": "example",
        "description": "example",
        "fileUrl": "example",
        "mimeType": "example",
        "fileSize": 1,
        "createdAt": "example",
        "updatedAt": "example"
      }
    ],
    "accountId": 1,
    "createdByUserId": 1,
    "visibility": "PRIVATE",
    "createdAt": "example",
    "updatedAt": "example",
    "assignedAt": "example",
    "integrations": [
      "GMAIL"
    ],
    "selectedRecordTypes": [
      {
        "recordTypeId": 1
      }
    ],
    "selectedCustomTools": [
      {
        "id": 1
      }
    ],
    "connectedAccounts": [
      {
        "id": 1,
        "toolkit": "example",
        "connectedEmail": "example",
        "alias": "example"
      }
    ]
  }
}

Changes