Skip to main content

EnrollContact starts a new pipeline run with the given contact as the subject. The pipeline must be `published` with `subject_type = 'contact'`. The first stage's actions are materialised and the run enters `running` status.

POST 

/api/v1/crm/contacts/:contactId/pipeline-runs

Errors:

  • UNAUTHENTICATED: missing auth context.
  • NOT_FOUND: contact does not exist (ErrContactNotFound); pipeline does not exist (ErrPipelineNotFound).
  • FAILED_PRECONDITION: pipeline is not published (ErrPipelineNotPublished); pipeline subject_type is not "contact" (ErrPipelineSubjectMismatch); the contact already has an open run for this pipeline (ErrPipelineAlreadyEnrolled).

Request

Responses

A successful response.