1. API reference
  2. Pages · Scripts
  3. Change definitions key scripts scriptId
Open Specter
  • Overview
  • GETRead the board
  • POSTAdd rows
  • GETList the custom boards
  • POSTMake a board
  • POSTImport rows into a board
  • POSTImport a spreadsheet onto a board, mapping it for you
  • POSTRead the cells an import column could not, with the model
  • GETRead one board, whole
  • DELETEDelete a board and everything on it
  • PATCHRename a board or switch its layout
  • PATCHWrite many rows' cells at once
  • GETThe buttons on a board's action bar
  • POSTAdd a button to a board's action bar
  • PUTReorder a board's action bar
  • DELETERemove a board's action button
  • PATCHChange a board's action button
  • GETIngestion keys minted on a board
  • POSTMint an ingestion key for a board
  • DELETERevoke a board's ingestion key
  • GETWhat one board key has done lately
  • GETWhich columns are locked on a board
  • GETWhat this caller gets on a board
  • PUTLock a column on a board
  • DELETEUnlock a column on a board
  • POSTAdd a column to a board
  • PUTReorder a board's columns
  • DELETETake a column off a board
  • PATCHRename or reconfigure a board column
  • PUTChoose the figure the calculations strip shows under a board column
  • PUTSet a board column's formula expression
  • POSTAdd a choice to a board's select column
  • PUTReorder a board column's choices
  • DELETERemove a choice from a board column
  • PATCHRelabel or recolour one choice
  • GETWho else can reach this board
  • PUTShare a board with a colleague
  • DELETEStop sharing a board
  • GETBoard import history
  • POSTRecord a board import run
  • POSTUndo a board import
  • GETRead a page of a board's rows
  • POSTAdd a row to a board
  • POSTDelete records from a board
  • PATCHChange one board record's cells
  • GETFiles pinned to one board record
  • POSTAttach a file to a board record
  • GETSaved views on a board
  • POSTSave a view on a board
  • PUTReorder a board's saved views
  • DELETEDelete a saved board view
  • PATCHChange a saved board view
  • GETRead the lenders a capital source backs
  • GETList the pages (leads, deals, merchants, lenders, contacts, tasks…) and their keys
  • GETRead a page's definition: its columns, statuses and roles
  • PATCHChange definitions key
  • GETSum, count or average a page's records
  • POSTSet who a page is shown to
  • PATCHWrite many records' cells at once
  • GETList the child pages a page accepts
  • PUTDeclare the child pages a page accepts
  • POSTCreate definitions key credit-memos id transition
  • DELETEDelete a credit record
  • GETRead a page's filter facets
  • POSTPull the next record from a work queue
  • GETRead what this page's moves ask for
  • PUTSet what one move asks for
  • GETList a page's row actions
  • POSTAdd a row action to a page
  • PUTReorder a page's row actions
  • DELETERemove a row action from a page
  • PATCHChange definitions key actions actionId
  • GETRead definitions key api-keys
  • POSTCreate definitions key api-keys
  • DELETERemove definitions key api-keys keyId
  • GETWhat one page API key has done lately
  • GETRead a page's column locks
  • GETRead the column locks in force for the caller
  • PUTLock or unlock a column
  • DELETEClear a column's lock
  • POSTAdd a column to a page
  • PUTReorder a page's columns
  • DELETERemove a column from a page
  • PATCHChange definitions key columns columnId
  • PUTChoose the figure the calculations strip shows under a page column
  • GETList relationships on this page
  • POSTName a relationship
  • DELETEDissolve a relationship
  • PATCHRename a relationship or set its principal
  • GETRead a relationship's members
  • POSTPut records into a relationship
  • DELETETake one record out of a relationship
  • GETWho is held back on a pack page
  • PUTHold a member back on a pack page
  • DELETEGive a member a pack page back
  • GETList a page's record groups
  • POSTCreate a record group on a page
  • POSTMove records between groups
  • POSTTake records out of their groups
  • DELETEDelete a record group
  • PATCHChange definitions key groups groupId
  • GETList the records in a group
  • POSTAdd records to a group
  • POSTRemove records from a group
  • POSTImport rows into a page
  • POSTImport a spreadsheet, mapping it for you
  • POSTImport rows as a job
  • GETRead an import job's progress
  • GETList a page's imports
  • POSTImport a spreadsheet into a page
  • POSTUndo an import batch
  • GETList or search a page's records
  • POSTCreate a record on a page (lead, deal, merchant, lender, contact, task)
  • POSTAdopt a shared record onto this page
  • POSTAssign one person to many records
  • GETPick the next assignee in a rotation
  • POSTUpdate many records at once
  • POSTDelete records from a page
  • GETLeads due today
  • GETCount a page's records by column value
  • POSTTake in a new lead from a form or a call
  • POSTOnboard a lead
  • GETRead one record
  • PATCHChange definitions key rows rowId
  • GETRead a record's activity feed
  • GETRead a deal's AI insights
  • POSTRegenerate a deal's AI insights
  • POSTRun business research on a deal
  • POSTArchive a record
  • PUTPut one person in a role on a record
  • POSTEmail whoever holds a role on a deal
  • GETRead who is assigned to a record, by role
  • PUTSet who holds a role on a record
  • DELETETake one person off a role on a record
  • GETList a record's bank statements
  • POSTClose a deal
  • GETHow this deal ended
  • POSTDraw up a deal's contract
  • GETList a deal's contract documents
  • POSTAdd a document to a deal's contract
  • POSTSend the contract for signature
  • GETList a deal's signature requests
  • GETRead the signed contract
  • POSTConvert a lead into a deal
  • GETRead a deal's credit records
  • POSTRecord a credit record
  • GETList a record's credit reports
  • GETList a record's debt schedules
  • POSTAdd a debt schedule to a record
  • PATCHChange definitions key rows rowId debt-schedules scheduleId
  • POSTCreate definitions key rows rowId debt-schedules scheduleId issue
  • GETRead one record in full: cells, people, files, activity
  • GETRead a submission's financing disclosure
  • POSTGenerate a submission's financing disclosure
  • GETList a record's document analyses
  • GETList the documents requested from a record
  • POSTRequest documents from a record's contact
  • GETRead a deal's document checklist
  • PUTSet a document's standing on a deal
  • GETRead a record's merged feed
  • PUTReact to a feed item
  • DELETERemove a reaction from a record's feed
  • GETList a record's files
  • POSTAttach a file to a record
  • PUTFile a document into a folder
  • GETRead a record's financials
  • GETList a record's document folders
  • POSTCreate a document folder
  • DELETEDelete an empty document folder
  • PATCHRename or move a document folder
  • PUTFollow a record
  • DELETEUnfollow a record
  • POSTMint a form link for a record
  • POSTFund a deal
  • GETRead a record's health score
  • GETList the heartbeat's proposed actions for a record
  • GETRead this deal's lender recommendations
  • GETList the lenders eligible for a deal
  • GETRead a deal's lifecycle stage
  • POSTMatch and connect records
  • GETList the invitations sent to a merchant
  • POSTInvite a merchant to their portal
  • DELETEWithdraw a merchant invitation
  • GETList a deal's offers
  • POSTAdd an offer to a deal
  • POSTFinish a bank link for a deal
  • GETA deal's linked banks
  • DELETEUnlink a bank from a deal
  • POSTStart a bank link for a deal
  • POSTPull a deal's linked banks
  • POSTProcess a record's documents
  • GETRead a record's document-processing status
  • POSTReactivate an archived record
  • GETList a record's related records
  • GETRead a record's call script
  • DELETERemove a record's call script
  • POSTAsk for help with a record's call script
  • POSTGenerate a call script for a record
  • POSTSeat one team on a record
  • GETSigning requests on a record
  • GETList a record's e-signature events
  • GETRead one record's SLA state
  • POSTSnooze a lead
  • GETList a record's statements
  • POSTChange a record's status
  • GETRead a record's status history
  • POSTRequest stipulations
  • GETRead saved deal submission notes
  • PUTSave deal submission notes
  • GETList a deal's submissions to lenders
  • POSTSubmit one deal to many lenders
  • GETList a record's subrecords
  • POSTAttach or create a subrecord
  • DELETEDetach a subrecord
  • GETRead a record's Super KYC links
  • POSTCreate a Super KYC link
  • GETRead a Super KYC link's findings
  • DELETEStop a Super KYC link
  • POSTAcknowledge a Super KYC finding
  • GETList a record's tax returns
  • GETList a record's discussion threads
  • POSTStart a discussion thread on a record
  • POSTMove a deal's status
  • GETWhat a move needs first
  • GETRead a deal's underwriting result
  • POSTRun underwriting on a deal
  • POSTEvaluate a deal against the published rules
  • GETList a deal's rule evaluations
  • GETRead one rule evaluation
  • GETList the rule namespace for a deal
  • GETRead a record's vendor slots
  • PUTName the vendor for one slot
  • DELETEEmpty one vendor slot
  • GETList a page's call scripts
  • POSTAdd a call script to a page
  • DELETERemove a call script from a page
  • PATCHChange definitions key scripts scriptId
  • POSTAdd a status to a page
  • PUTReorder a page's statuses
  • DELETERemove a status from a page
  • PATCHChange definitions key statuses statusId
  • GETRead a discussion thread
  • DELETEDelete a thread
  • PATCHChange definitions key threads threadId
  • GETList a thread's messages
  • POSTPost a message on a thread
  • DELETEDelete a thread message
  • PATCHChange definitions key threads threadId messages messageId
  • POSTPin a thread message
  • GETList who is on a thread
  • POSTAdd someone to a thread
  • DELETETake someone off a thread
  • POSTMark a thread read
  • POSTResolve a thread
  • PATCHChange definitions key underwriting id
  • PUTSet an underwriting rule set's criteria
  • POSTEvaluate a deal against an underwriting rule set
  • POSTSave a view of a page
  • DELETEDelete a saved view
  • PATCHChange definitions key views viewId
  • GETThe workspace's forms
  • POSTBuild a form
  • POSTMake a form for a board
  • GETRead one form
  • DELETEDelete a form and its answers
  • PATCHChange a form
  • GETForm analytics
  • GETWhere this form lives on the web
  • POSTPublish a form
  • GETWhat people filed through one form
  • POSTMint a correction link for one submission
  • GETWhich correction links stand open
  • POSTUnpublish a form
  • POSTCheck a business for ISO conflicts
  • POSTRun an ISO conflict check
  • GETRead the ISO network roster
  • GETLead snapshot
  • GETList every lender and how a submission reaches it
  • GETList the lenders linked to a Specter workspace
  • PUTLink a lender record to its Specter workspace
  • DELETEUnlink a lender record from its Specter workspace
  • GETLender analytics
  • POSTInstall a pack
  • GETThe score bands offers are priced against
  • GETFind a record by name
  • GETList submissions to lenders
  • POSTSend one deal to one lender
  • GETSubmission analytics
  • POSTSubmit a deal to several lenders at once
  • POSTMove a submission to a lender
  • GETRead table-preferences
  • GETRead table-preferences tableKey
  • PUTReplace table-preferences tableKey
  • DELETERemove table-preferences tableKey
  • GETRead the blasts
  • POSTCompose a blast to many people
  • GETRead blast statistics
  • PATCHChange a blast's words
  • POSTAdd people to a blast's audience
  • POSTCancel a blast
  • POSTSend a scheduled blast
  • GETRead a blast's report
  • POSTSchedule a blast
  • GETRead the calendar
  • POSTBook a meeting
  • DELETECall a meeting off
  • PATCHChange a meeting
  • GETRead the call log
  • POSTPlace a call from a record
  • GETList conversations
  • POSTOpen a conversation with an address
  • PATCHStar, pin or archive a conversation
  • POSTLog a call that already happened
  • GETRead a conversation's messages
  • POSTSend a message on a conversation
  • POSTMute a conversation
  • GETRead who is on a conversation
  • POSTAdd somebody to a conversation
  • DELETETake somebody off a conversation
  • POSTMark a conversation read
  • POSTFile a conversation under a record
  • DELETEUnfile a conversation from a record
  • PATCHChange who may see a conversation
  • POSTDraft a message with Neo
  • POSTRecord a text that arrived
  • GETRead the addresses the desktop rail may upload
  • GETRead the workspace's inboxes
  • PUTPut somebody on an inbox
  • DELETETake somebody off an inbox
  • PUTSet one inbox's privacy
  • DELETEDelete a message
  • POSTCancel a queued message
  • PATCHRecord a message's delivery status
  • GETRead a message and its replies
  • GETRead the workspace's phone numbers
  • POSTBuy a phone number
  • GETSearch phone numbers for sale
  • DELETERelease a phone number
  • POSTClaim outbound sends
  • POSTRecord a carrier's delivery receipt
  • POSTReport what became of a send
  • GETRead one call recording
  • DELETERemove a call recording
  • POSTSummarise a call recording
  • GETRead a record's contact addresses
  • POSTMark a record's conversations read
  • GETRead a records call recordings
  • POSTSend a text or an email to an address
  • GETList the lines I can send from
  • GETRead who may see messages by default
  • PUTSet who may see messages by default
  • GETRead the email signatures
  • PUTSet an address's email signature
  • DELETEStop signing an address
  • GETRead the text message log
  • GETRead one email blast
  • GETRead the addresses the workspace sends and receives on
  • POSTConnect a mailbox
  • DELETEDisconnect a mailbox
  • GETRead what a provider said about a mailbox
  • GETRead the standing message rules
  • POSTArm a standing message rule
  • DELETEDelete a standing message rule
  • PATCHChange a standing message rule
  • GETRead the approval queue
  • POSTWrite a draft for somebody to look over
  • DELETEDelete a draft
  • PATCHChange message-drafts id
  • POSTApprove a draft
  • POSTCancel a draft
  • GETList the placeholders a message template can use
  • GETRead the message templates
  • POSTKeep a reusable message body
  • POSTGive a workspace the starter templates
  • DELETEDelete a message template
  • PATCHChange a message template
  • POSTSee what a template would say
  • POSTMake a template the default
  • GETRead your notification settings
  • PATCHChange your notification settings
  • GETRead the notification types
  • POSTAdd a notification type
  • DELETERetire a notification type
  • POSTRaise a notification
  • GETList notifications
  • POSTDismiss notifications
  • POSTMark every notification read
  • POSTMark notifications read
  • GETCount your unread notifications
  • POSTQueue personalized messages
  • GETRead push public-key
  • GETRead push subscriptions
  • POSTCreate push subscriptions
  • DELETERemove push subscriptions id
  • GETRead one text blast
  • POSTCount who a text blast would be resent to
  • POSTSend a blast again to whoever did not reply
  • GETList discussion threads
  • GETList allocations
  • POSTAllocate a bank transaction
  • DELETEUndo an allocation
  • GETList bank transactions
  • POSTRecord a bank transaction
  • GETRead a bank transaction
  • GETRead the accounting dashboard
  • GETList deal costs
  • POSTRecord a deal cost
  • POSTMark a deal cost paid
  • POSTVoid a deal cost
  • GETList deal splits
  • POSTCreate a deal split
  • GETRead a deal split
  • PATCHChange accounting deal-splits id
  • POSTDeactivate a deal split
  • POSTPut a deal split on hold
  • POSTRelease a deal split's hold
  • GETList deals in the ledger
  • POSTAdd a deal to the ledger
  • GETRead a ledger deal
  • DELETERemove a deal from the ledger
  • PATCHChange accounting deals id
  • POSTMark a ledger deal defaulted
  • GETRead a ledger deal in full
  • POSTPut a ledger deal on hold
  • POSTRelease a ledger deal's hold
  • GETList accounting exceptions
  • GETRead the caller's own available balance
  • GETList payout requests
  • POSTRequest a payout
  • GETRead a payout request
  • POSTApprove a payout
  • POSTCancel a payout request
  • POSTMark a payout paid
  • POSTReject a payout
  • POSTSend an approved payout to the bank
  • GETRead the workspace's billing
  • POSTCancel at the end of the period
  • GETRead what can be bought
  • GETRead the AI credit balance and ledger
  • POSTBuy a credit pack
  • GETRead the billing history
  • POSTOpen the Stripe customer portal
  • POSTChange the plan or the seat count
  • GETRead this period's usage
  • GETList cash flows
  • POSTCreate a cash flow
  • GETRead a cash flow
  • POSTMark a cash flow failed
  • POSTMark a cash flow missed
  • POSTRecord a payment against a cash flow
  • GETList credit memos
  • POSTCreate a credit memo
  • GETRead a credit memo
  • DELETEDelete a credit memo
  • PATCHChange credit-memos id
  • POSTApprove a credit memo
  • POSTReject a credit memo
  • POSTSubmit a credit memo
  • POSTPut a deal's merchant on the payment rail
  • GETRead the money moved through Finix
  • GETWhat is owed on the deals
  • POSTRaise an obligation
  • GETRead one obligation
  • PATCHChange an obligation
  • POSTComplete an obligation
  • POSTMark an obligation overdue
  • POSTWaive an obligation
  • GETThe repayment schedules being collected
  • POSTRaise a repayment schedule
  • GETRead one repayment schedule
  • DELETEDestroy a schedule and its instalments
  • POSTClose out a schedule
  • POSTPause collection on a schedule
  • GETThe instalments under one schedule
  • GETHow one schedule is performing
  • POSTResume a paused schedule
  • GETA schedule's debit authorisations
  • POSTAsk the merchant to authorise the debit
  • GETThe instalments that are late
  • GETThe instalments still to come
  • GETRead one instalment
  • GETHow one receipt was split
  • POSTCollect a due payment through Finix
  • POSTMark an instalment failed on the rail
  • POSTMark an instalment missed
  • POSTAgree an instalment against the bank
  • POSTRecord money collected on an instalment
  • POSTReverse a booked receipt
  • POSTForgive an instalment
  • GETPortfolio aging
  • GETPortfolio health
  • GETCollections projection
  • POSTRecord the merchant's consent to debit
  • POSTWithdraw an unanswered authorisation request
  • POSTRevoke a live debit authorisation
  • GETThe deals that are behind
  • POSTOpen a delinquency case
  • POSTFind delinquent facilities now
  • POSTLog chasing a delinquent borrower
  • POSTResolve a delinquency case
  • GETHow facilities ended
  • POSTRecord how a facility ended
  • GETRead a picked cloud file's bytes
  • GETList outstanding document requests
  • POSTCancel a document request
  • POSTFulfil a document request
  • GETList document templates
  • POSTCreate a document template
  • GETSigning requests on a document
  • POSTSend a document for signature
  • GETBrowse the caller's Google Drive
  • GETRead a Google Sheet as a file
  • GETList the workspace's files
  • POSTUpload a file
  • DELETEDelete a file
  • PATCHChange files id
  • POSTAnalyse a document
  • GETDownload a file
  • GETBrowse the caller's OneDrive
  • GETRead a signing request
  • POSTCancel a signing request
  • GETRead the executed document
  • POSTRemind a request's signers
  • GETRead storage-accounts
  • POSTCreate storage-accounts
  • DELETERemove storage-accounts id
  • GETRead the workspace's activity feed
  • GETAgent performance
  • GETRead what an agent brought in
  • GETRead integrations
  • DELETEDelete integrations zoom connection
  • GETRead integrations zoom oauth authorize
  • GETRead integrations zoom phone-numbers
  • GETRead integrations zoom status
  • GETRead integrations zoom users
  • GETRead integrations provider
  • PUTReplace integrations provider
  • DELETERemove integrations provider
  • POSTCreate integrations provider test
  • GETWhat a report can be built from
  • POSTRun an unsaved report definition
  • DELETERevoke a public report link
  • GETThe saved reports
  • POSTSave a report
  • DELETEDelete a saved report
  • PATCHChange a saved report
  • POSTRun a saved report
  • GETPublic links on one report
  • POSTPublish a public report link
  • GETList tasks
  • POSTCreate a task
  • GETRead task figures
  • PATCHChange a task
  • GETRead a task's comments
  • POSTComment on a task
  • POSTMark a task done
  • GETRead webhooks
  • POSTCreate webhooks
  • GETRead webhooks id
  • DELETERemove webhooks id
  • PATCHChange webhooks id
  • GETRead webhooks id deliveries
  • POSTCreate webhooks id rotate
  • POSTCreate webhooks id test
  • GETList workflows
  • POSTStart a workflow draft
  • GETThe workflow vocabulary
  • GETWorkflow steps waiting on a person
  • POSTAnswer a workflow review
  • GETWorkflow runs, newest first
  • GETOne run, its steps and its reviews
  • POSTStop a running workflow run
  • POSTCheck a workflow definition
  • GETOne workflow and its draft's problems
  • DELETEDelete an unpublished draft
  • PATCHEdit a workflow draft
  • POSTPublish a workflow — it goes live
  • POSTPublish an old version again
  • POSTRun a published workflow by hand
  • GETEvery publish of one workflow
  • POSTCreate client errors
  • GETRead your calendar settings
  • PATCHChange your calendar settings
  • GETRead my day
  • GETRead my screen-capture protection
  • POSTAllow screen capture of my window for a while
  • GETRead my call-script template
  • PUTReplace my call-script template
  • GETRead my usage summary
  • GETRead preferences
  • GETRead preferences key
  • PUTReplace preferences key
  • GETRead workspace preferences
  • GETRead workspace preferences key
  • PUTReplace workspace preferences key
  • PATCHChange workspace
  • GETRead the workspace's refused calls
  • GETRead the workspace's automated emails
  • PUTReplace the workspace's automated emails
  • GETRead the states this workspace discloses in
  • PUTReplace the states this workspace adds
  • GETBrowse Drive folders
  • GETRead the execution profile
  • PUTSave the execution profile
  • DELETERemove an inbound address
  • PATCHRe-aim or pause an inbound address
  • PUTReplace workspace kyc
  • POSTCreate workspace kyc submit
  • GETList the published lender catalogue
  • POSTAdopt a catalogue lender onto the Lenders board
  • GETRead workspace mcp usage
  • GETList businesses that appear on more than one page
  • GETRead the workspace's plan and seats
  • GETRead what the workspace still needs set up
  • GETRead the SLA dashboard tile
  • GETRead workspace staff-access
  • GETRead the workspace at a glance
  • GETRead which teams' records the caller sees
  • GETRead workspace usage events
  • GETRead workspace usage summary
  • GETGET /v1/workspace/vocabulary
  • POSTPOST /v1/workspace/vocabulary
  • GETRead workspace agreements kind
  • POSTCreate workspace agreements kind sign
  • POSTCreate workspace agreements kind viewed
  • GETRead workspace api-keys
  • POSTCreate workspace api-keys
  • DELETERemove workspace api-keys keyId
  • GETRead a key's partner-API state
  • POSTCreate workspace api-keys keyId rotate
  • GETRead workspace api-keys keyId usage
  • GETRead the workspace's compliance reports
  • POSTGenerate a compliance report
  • DELETEDelete a compliance report
  • PATCHChange a compliance report
  • POSTRun a compliance report now
  • GETRead a report's runs
  • GETRead one compliance run
  • POSTSign off, reject or reopen a run
  • GETRead workspace delegation
  • PUTReplace workspace delegation
  • DELETERemove workspace delegation
  • POSTCreate workspace delegation microsoft start
  • POSTCreate workspace delegation sync
  • GETList the connected directory's people
  • POSTInvite people from the directory
  • PUTSet directory provisioning
  • POSTSync seats against the directory
  • GETList workspace domains
  • POSTAdd a workspace domain
  • GETRead one workspace domain
  • DELETERemove a workspace domain
  • GETList a domain's inbound addresses
  • POSTAdd an inbound address
  • POSTRecheck a domain's DNS
  • GETList Drive watches
  • POSTWatch a Drive folder
  • DELETEStop watching a Drive folder
  • POSTSweep a Drive watch now
  • GETRead workspace heartbeat
  • PUTReplace workspace heartbeat
  • GETRead workspace heartbeat actions
  • POSTDecide heartbeat items in bulk
  • POSTApply a heartbeat action
  • POSTDefer a heartbeat item
  • POSTRefuse a heartbeat action
  • POSTTake back a heartbeat decision
  • GETList the heartbeat's runs
  • GETRead one heartbeat run
  • POSTCreate workspace heartbeat test
  • GETList open invites
  • POSTInvite someone to the workspace
  • DELETEWithdraw an invite
  • GETList the workspace's members and their roles
  • DELETERemove a member from the workspace
  • PATCHChange workspace members accountId
  • POSTPause a member's seat
  • POSTLet a paused member back in
  • GETRead where the workspace's applications arrive
  • DELETERemove an alias from the workspace's intake mailbox
  • DELETEDisconnect the workspace's intake mailbox
  • POSTAdd an alias to the workspace's intake mailbox
  • GETList an intake mailbox's existing Gmail aliases
  • GETRead what counts as a processed deal
  • PUTChange what counts as a processed deal
  • POSTTest the processor criteria on recent mail
  • POSTConnect the workspace's own intake mailbox
  • PUTChoose where applications arrive
  • GETRead the workspace's processor whitelist
  • POSTLet a seatless sender email the processor
  • DELETERemove a sender from the workspace's processor whitelist
  • GETRead workspace rep
  • GETRead workspace rep thread
  • POSTCreate workspace rep thread messages
  • GETRead the workspace's SLA policies
  • POSTPromise a stage an SLA
  • DELETEWithdraw a stage's SLA
  • PATCHChange a stage's SLA
  • GETList support tickets
  • POSTOpen a support ticket
  • GETRead a support ticket
  • POSTComment on a support ticket
  • GETList the workspace's teams
  • POSTCreate a team
  • DELETEDelete a team
  • PATCHChange workspace teams teamId
  • PUTPut a member on a team
  • DELETETake a member off a team
  • GETRead the workspace's underwriting criteria
  • PUTSet the workspace's underwriting criteria
  • POSTSeed the workspace's underwriting criteria
  • GETList the underwriting rule sets
  • POSTCreate an underwriting rule set
  • POSTSeed the default underwriting rule set
  • GETRead one underwriting rule set
  • PATCHChange an underwriting rule set
  • POSTPublish an underwriting rule set
  • POSTAdd an underwriting rule
  • DELETEDelete an underwriting rule
  • PATCHChange an underwriting rule
  • GETList an underwriting rule set's versions
  • GETRead the underwriting settings
  • PUTSave the underwriting settings
  • GETRead the workspace's vendors
  • POSTEngage a vendor
  • DELETERemove a vendor
  • PATCHChange a vendor
  • POSTPin a document to a vendor
  • DELETEUnpin a vendor's document
PATCH/v1/definitions/{key}/scripts/{scriptId}

Change definitions key scripts scriptId

Edits a call script, which in this table means writing the NEXT VERSION: the live version is retired and a new one written in the same transaction, so the ladder never has two live rungs and never has none. It answers 201 with the new script, because the id the caller sent is not the id it now holds. A field not sent is inherited. The id may name any version — the ladder continues from the LIVE one. Leads page, admin.

Access class: def:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keypath · stringrequired
scriptIdpath · stringrequired

Request body

application/jsonrequired
bodyoptional
paramsoptional
queryobjectoptional

Responses

200application/json

the action's answer

{
  "data": {
    "branches": [
      "string"
    ],
    "brief": {
      "headline": "string"
    },
    "createdAt": "string",
    "definitionKey": "string",
    "generator": "string",
    "id": 1.5,
    "kind": "string",
    "name": "string",
    "scope": "string",
    "spine": [
      {
        "key": "string",
        "label": "string",
        "purpose": "string",
        "say": "string"
      }
    ],
    "updatedAt": "string",
    "version": 1.5
  }
}
datarequired
defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}
errorstringrequired
Remove a call script from a page< PreviousAdd a status to a pageNext >
curl --request PATCH \  'https://neo-app-api-prod-836053680024.us-central1.run.app/v1/definitions/string/scripts/{scriptId}' \  --header 'Content-Type: application/json' \  --data '{  "body": {    "branches": [      {        "children": "string",        "exit": "string",        "id": "",        "next": "string",        "say": "string",        "tag": "string",        "trigger": "string"      }    ],    "brief": {      "headline": "string",      "hooks": [        "string"      ],      "key_facts": [        "string"      ],      "watch_outs": [        "string"      ]    },    "name": "string",    "spine": [      {        "key": "string",        "label": "string",        "purpose": "string",        "say": "string"      }    ]  },  "params": {    ":key": "string",    ":scriptId": ""  },  "query": {}}'
{  "data": {    "branches": [      "string"    ],    "brief": {      "headline": "string"    },    "createdAt": "string",    "definitionKey": "string",    "generator": "string",    "id": 1.5,    "kind": "string",    "name": "string",    "scope": "string",    "spine": [      {        "key": "string",        "label": "string",        "purpose": "string",        "say": "string"      }    ],    "updatedAt": "string",    "version": 1.5  }}