Sweep Fields

post/sweep_fields

Request

  • Base URL: https://api.sweep.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.sweep.io/sweep_fields
  • Auth: HTTP bearer

Query parameters

crmOrgIdstring required
draftboolean required

Request body

idstring
objectNamestring required
sweepFieldNamestring required
sfFieldNamestring
fieldType'Id' | 'Address' | 'AutoNumber' | 'Checkbox' | 'Currency' | 'Date' | 'DateTime' | 'Email' | 'Html' | 'EncryptedText' | 'Geolocation' | 'Hierarchy' | 'LongTextArea' | 'Lookup' | 'MasterDetail' | 'MultiselectPicklist' | 'Name' | 'Name2' | 'Number' | 'Percent' | 'Phone' | 'Picklist' | 'Summary' | 'Text' | 'TextArea' | 'Time' | 'Unknown' | 'Url' | 'FormulaCheckbox' | 'FormulaCurrency' | 'FormulaDate' | 'FormulaDateTime' | 'FormulaNumber' | 'FormulaPercent' | 'FormulaText' | 'FormulaTime' | 'Combobox' required
compoundFieldIdstring
isCompoundboolean
propertiesobject required
origin'SF_STANDARD' | 'SF_CUSTOM' | 'SWEEP_CUSTOM' | 'MP_CUSTOM'
isRequiredboolean
isCreatedInSweepboolean
helpTextstring
descriptionstring
pinToFunnelMapstring
sfDisplayType'ADDRESS' | 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'GEOLOCATION' | 'TEXTAREA' | 'LONGTEXTAREA' | 'REFERENCE' | 'MULTIPICKLIST' | 'NUMBER' | 'PERCENT' | 'PHONE' | 'PICKLIST' | 'COMBOBOX' | 'STRING' | 'TIME' | 'URL' | 'INTEGER' | 'DOUBLE' | 'ID' | 'ENCRYPTEDSTRING' | 'Unknown'

Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.