copyfactory.io
  • Getting started
    • Overview
      • Authentication
      • Rate limiting
      • Errors
  • API
    • Playbooks
      • The playbook object
      • List playbooks
    • Sequences
      • The sequence object
      • List sequences
    • Contacts
      • The contact object
      • Create contact
      • Get contact
      • Search contacts
    • Profiles
      • The profile object
      • Get a profile
      • List all profiles
    • Premises
      • The premise object
      • Get a premise
      • List all premises
    • Generations
      • The generations object
      • Generate text
  • Text Generation Tutorials
    • How to generate text
  • App
    • Website
    • Login
Powered by GitBook
On this page
  1. API
  2. Premises

The premise object

Attribute
Type
Description

id

int

The unique identified for the premise.

premise_name

string

The display name of the premise.

required_variables

array

The required variables needed in order to generate the premise.

premise_type

string

The type of premise, either 'email' or 'sentence'.

profile_name

string

The name of the profile this premise is attached to.

PreviousPremisesNextGet a premise

Last updated 2 years ago