Commands

#The Command object

Enrollment or stop command. Completed processing does not confirm sending.

Attributes

• objectstring
  Object type, always command.
• idstring (uuid)
  Identifier for polling this command.
• kindstring
  enroll: enrollment; stop: stopping. Values: enroll stop
• statestring
  accepted, running, done, done_with_unknown, failed. This is the command processing state. Values: accepted running done done_with_unknown failed
• workspace_idstring (uuid)
  Original command workspace.
• campaign_idstring (uuid)
  Original command campaign.
• lead_idstring (uuid) or null
  Stop target lead; null for a batch.
• created_atstring (date-time)
  Command acceptance time.
• finished_atstring (date-time) or null
  Completion time or null.
• cleanup_pendingboolean
  Stopped work still needs cleanup. Continue polling.
• resultobject
  Enrollment counters or stop result.
• itemsarray of object
  Lead results in input order. Empty for a stop. Up to 100 items.
  Child attributes

  • input_indexinteger
    Zero-based input index.
  • lead_idstring (uuid) or null
    Accepted or existing lead; null on rejection.
  • usernamestring or null
    Normalized username or null. Up to 32 characters.
  • external_idstring or null
    External identifier or null. Up to 128 characters.
  • statusstring
    accepted: new lead; existing: existing and unchanged; rejected: refused. Values: accepted existing rejected
  • reasonstring or null
    Rejection or hold reason, or null.
  • warningsarray of string
    first_message_long at 700 characters or more. Up to 1 items.
  • queue_statestring
    waiting, queued, held, failed, stopped, not_required. Enqueue does not confirm sending. Values: waiting queued held failed stopped not_required

#The CommandItem object

Intake and enqueue result for one lead.

Attributes

• input_indexinteger
  Zero-based input index.
• lead_idstring (uuid) or null
  Accepted or existing lead; null on rejection.
• usernamestring or null
  Normalized username or null. Up to 32 characters.
• external_idstring or null
  External identifier or null. Up to 128 characters.
• statusstring
  accepted: new lead; existing: existing and unchanged; rejected: refused. Values: accepted existing rejected
• reasonstring or null
  Rejection or hold reason, or null.
• warningsarray of string
  first_message_long at 700 characters or more. Up to 1 items.
• queue_statestring
  waiting, queued, held, failed, stopped, not_required. Enqueue does not confirm sending. Values: waiting queued held failed stopped not_required

#The EnrollResult object

Attributes

• acceptedinteger
  Number of new leads accepted for enqueue.
• insertedinteger
  Number of inserted records, including a possible policy rejection after insertion. Excludes existing.

#The StopResult object

Attributes

• automation_statestring
  stopping: sending started; stopped: no new attempts will start. Values: stopped stopping
• send_in_flightboolean
  An in-flight send may still complete.
• unknown_outcome_message_idsarray of string
  Opaque identifiers of unknown outcomes. Do not retry these sends.

#Get a command

GET/v1/commands/{id}

Requires the command kind permission: leads:enroll for enroll, leads:stop for stop. Polling does not start sending.

Permission

leads:enroll | leads:stop

Request weight

1

Parameters

• idstring (uuid), pathrequired
  Command identifier.

Response

Returns a Command object.

Endpoint-specific errors

• scope_required: The key does not permit the operation. A command requires its kind permission.
• not_found: The object was not found or is outside the key's scope. An unknown path also returns 404.

Common errors are described in Errors.