curl --request PUT \
  --url https://openapi.enginy.ai/v1/ai-playbook \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "faqs": {
    "upsert": [
      {
        "question": "Do you offer a free trial?",
        "answer": "Yes, 14 days."
      }
    ]
  }
}
'

{
  "status": "success",
  "message": "<string>",
  "data": {
    "company": {
      "name": "<string>",
      "company": "<string>",
      "companyIndustry": "<string>",
      "companyNumberOfEmployees": "<string>",
      "companyHeadquartersLocation": "<string>",
      "companyFoundingYear": "<string>",
      "companyWebsite": "<string>",
      "companyLinkedinUrl": "<string>",
      "companyOverview": "<string>",
      "companyProductsServices": "<string>"
    },
    "allCompanyProductsServices": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "valueProposition": "<string>",
        "minPrice": 123,
        "maxPrice": 123,
        "currency": "<string>",
        "isMainProduct": true
      }
    ],
    "idealCustomerProfiles": [
      {
        "id": 123,
        "name": "<string>",
        "jobTitles": [
          "<string>"
        ],
        "locations": [
          "<string>"
        ],
        "companyIndustry": "<string>",
        "companySize": "<string>",
        "keyPainPoints": "<string>",
        "additionalInfo": "<string>",
        "revenue": [
          "<string>"
        ],
        "disqualifyingFactors": "<string>",
        "linkedInFilters": "<unknown>"
      }
    ],
    "idealCompanies": [
      {
        "id": 123,
        "name": "<string>",
        "industry": "<string>",
        "imageUrl": "<string>",
        "description": "<string>",
        "linkedInUrl": "<string>",
        "companyUrn": "<string>"
      }
    ],
    "competitors": [
      {
        "id": 123,
        "name": "<string>",
        "productDifferentiator": "<string>",
        "linkedInUrl": "<string>"
      }
    ],
    "testimonials": [
      {
        "id": 123,
        "companyName": "<string>",
        "promoterName": "<string>",
        "jobPosition": "<string>",
        "mainBenefit": "<string>"
      }
    ],
    "faqs": [
      {
        "id": 123,
        "question": "<string>",
        "answer": "<string>"
      }
    ],
    "changes": {
      "companyFieldsUpdated": 123,
      "productsServices": {
        "created": 123,
        "updated": 123,
        "restored": 123,
        "deleted": 123
      },
      "idealCustomerProfiles": {
        "created": 123,
        "updated": 123,
        "restored": 123,
        "deleted": 123
      },
      "competitors": {
        "created": 123,
        "updated": 123,
        "restored": 123,
        "deleted": 123
      },
      "testimonials": {
        "created": 123,
        "updated": 123,
        "restored": 123,
        "deleted": 123
      },
      "faqs": {
        "created": 123,
        "updated": 123,
        "restored": 123,
        "deleted": 123
      }
    }
  }
}

AI Playbook

Update AI playbook

Update the company AI playbook for the workspace.

This endpoint is deliberately additive. Nothing you leave out is changed:

Omit a section (productsServices, idealCustomerProfiles, competitors, testimonials, faqs) and that whole section is untouched.
Items missing from a section’s upsert array are untouched — sending a shorter list never removes the rest.
Items are matched by their natural key (products, profiles and competitors by name; testimonials by companyName + promoterName; FAQs by question). A match updates the existing item, a new key creates one, and a key that was removed earlier is restored.
The only way to remove something is to list its id in that section’s deleteIds. Removals are reversible: sending the same key again restores the item.
Company-level fields are written only when provided and non-empty.

idealCompanies and the linkedInFilters of an ideal customer profile are generated by Enginy and cannot be written here.

Call GET /v1/ai-playbook first to read the current ids and values. The response returns the full playbook after the write plus a changes summary of what was created, updated, restored, and deleted per section.

Required scope: WORKSPACE_WRITE

Rate limit: 30 requests per minute

PUT

ai-playbook

curl --request PUT \
  --url https://openapi.enginy.ai/v1/ai-playbook \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "faqs": {
    "upsert": [
      {
        "question": "Do you offer a free trial?",
        "answer": "Yes, 14 days."
      }
    ]
  }
}
'

{
  "status": "success",
  "message": "<string>",
  "data": {
    "company": {
      "name": "<string>",
      "company": "<string>",
      "companyIndustry": "<string>",
      "companyNumberOfEmployees": "<string>",
      "companyHeadquartersLocation": "<string>",
      "companyFoundingYear": "<string>",
      "companyWebsite": "<string>",
      "companyLinkedinUrl": "<string>",
      "companyOverview": "<string>",
      "companyProductsServices": "<string>"
    },
    "allCompanyProductsServices": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "valueProposition": "<string>",
        "minPrice": 123,
        "maxPrice": 123,
        "currency": "<string>",
        "isMainProduct": true
      }
    ],
    "idealCustomerProfiles": [
      {
        "id": 123,
        "name": "<string>",
        "jobTitles": [
          "<string>"
        ],
        "locations": [
          "<string>"
        ],
        "companyIndustry": "<string>",
        "companySize": "<string>",
        "keyPainPoints": "<string>",
        "additionalInfo": "<string>",
        "revenue": [
          "<string>"
        ],
        "disqualifyingFactors": "<string>",
        "linkedInFilters": "<unknown>"
      }
    ],
    "idealCompanies": [
      {
        "id": 123,
        "name": "<string>",
        "industry": "<string>",
        "imageUrl": "<string>",
        "description": "<string>",
        "linkedInUrl": "<string>",
        "companyUrn": "<string>"
      }
    ],
    "competitors": [
      {
        "id": 123,
        "name": "<string>",
        "productDifferentiator": "<string>",
        "linkedInUrl": "<string>"
      }
    ],
    "testimonials": [
      {
        "id": 123,
        "companyName": "<string>",
        "promoterName": "<string>",
        "jobPosition": "<string>",
        "mainBenefit": "<string>"
      }
    ],
    "faqs": [
      {
        "id": 123,
        "question": "<string>",
        "answer": "<string>"
      }
    ],
    "changes": {
      "companyFieldsUpdated": 123,
      "productsServices": {
        "created": 123,
        "updated": 123,
        "restored": 123,
        "deleted": 123
      },
      "idealCustomerProfiles": {
        "created": 123,
        "updated": 123,
        "restored": 123,
        "deleted": 123
      },
      "competitors": {
        "created": 123,
        "updated": 123,
        "restored": 123,
        "deleted": 123
      },
      "testimonials": {
        "created": 123,
        "updated": 123,
        "restored": 123,
        "deleted": 123
      },
      "faqs": {
        "created": 123,
        "updated": 123,
        "restored": 123,
        "deleted": 123
      }
    }
  }
}

Authorizations

x-api-key

string

header

required

Body

application/json

company

object

Company-level playbook fields. Only the fields you provide are written; empty strings and null are ignored so a field is never cleared by accident.

Show child attributes

productsServices

object

Products and services. Omit this key to leave the whole section untouched.

Show child attributes

idealCustomerProfiles

object

Ideal customer profiles. Omit this key to leave the whole section untouched.

Show child attributes

competitors

object

Competitors. Omit this key to leave the whole section untouched.

Show child attributes

testimonials

object

Testimonials. Omit this key to leave the whole section untouched.

Show child attributes

faqs

object

FAQs. Omit this key to leave the whole section untouched.

Show child attributes

Response

The playbook after the update, plus a summary of what changed

status

enum<string>

required

Available options:

success

message

string

required

data

object

required

Show child attributes

API documentation

Endpoints

Update AI playbook

Authorizations

Body

Response