Create a new process | API

Created by Archie Barnett, Modified on Tue, 26 May at 8:46 PM by Jonathan Mugridge


{
    "title": "Example title",
    "journeyId": "guid",
    "webhookUrl": "string",
    "userGroupId": "guid",
    "processEntities": [
        {
            "firstName": "John",
            "surname": "Smith",
            "emailAddress": "user@example.com",
            "phoneNumber": "+447000000000",
            "reference": "Your customer reference",
            "actorId": 123,
            "contactViaEmail": true,
            "contactViaSms": true,
            "inPerson": false
        }
    ]
}

To determine how we contact these individuals you can set your contact preferences using the following fields:

contactViaEmail – if set to true we will send an invite via email.

contactViaSms – if set to true we will send via SMS.

inPerson – if true, no invites will be issued.

If you set contactViaEmail and/or contactViaSms to false, you can pass emailAddress or phoneNumber as null.

You can provide your webhookUrl as part of the request body.

Create a Process & new Entity (no contact)

To create a new process and entity (no contact) you must use the following request body:


{
    "title": "Example title",
    "journeyId": "guid",
    "webhookUrl": "string",
    "userGroupId": "guid",
    "processEntities": [
        {
            "firstName": "John",
            "surname": "Smith",
            "emailAddress": "user@example.com",
            "phoneNumber": "+447000000000",
            "reference": "Your customer reference",
            "actorId": 123,
            "contactViaEmail": false,
            "contactViaSms": false,
            "inPerson": false
        }
    ]
}

You must set contactViaEmail, contactViaSms and inPerson to false for no-contact.

Create a Process using an existing Entity

Use the following request body:


{
  "title": "Example title",
  "journeyId": "guid",
  "webhookUrl": "string",
  "userGroupId": "guid",
  "processEntities": [
    {
      "id": "guid",
      "reference": "Your customer reference",
      "actorId": 123,
      "contactViaEmail": true,
      "contactViaSms": true,
      "inPerson": false
    }
  ]
}

Join our live training sessions

Whether you're new to Credas or simply looking for a refresher, we’ve got you covered! We now offer regular training sessions designed to help you get the most out of the Credas platform. These sessions are tailored to different product areas, including:

- AML / ID verification
- Right to Work
- Our brand-new Credas Lettings solution
- Admin / advanced training

In each session we will walk you through how platform works and answer any questions you may have.

See our full training schedule