Stg Portal 2.0 API Refactoring (1.0.0)

Download OpenAPI specification:Download

The Credit Pros - STG Portal 2.0 API Refactoring

Attachment

An attachment is an entity of a file. It can be related to different entities and has a direct link to the file, a description (something like a label), file type, extension, size, creation date, and modification date.

Get list of attachments

Retrieving all files related to a specific entity, such as a client, correspondence, event, etc.

Authorizations:

bearerAuthx-api-key

query Parameters

entity_type required	string Entity type, a short name for the entity type. For example, if you need to upload a file for a document or a client, you should specify "client" or "client_document" here
entity_id required	integer The ID of this entity. For example, if you need to retrieve all files related to a client, and the client has an ID of 111, you should specify 111 here.
caption	string Search by file caption. For example, if a client has 100 files, and 10 of them are insurance documents, and you need to find the files related to insurance, you can enter the word "insurance" here. All file caption containing the word "insurance" will be returned.
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (AttachmentResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Upload an attachment

Uploading an attachment to create an entity and enable the attachment to be linked to other entities, such as clients, etc.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: multipart/form-data
required

file required	string <binary> File (jpg, jpeg, png, pdf, doc, docx)
caption	string or null Attachment caption

Responses

Response Schema: application/json

object (AttachmentResource)

Full information related to the attachment.

caption	string Attachment caption
created_at	string <date-time> Date and time of creation.
downloadUrl	string Download link.
extension	string Attachment extension
id	integer Unique identifier.
size	integer Attachment size
type	string Attachment type.
updated_at	string <date-time> Date and time of modification.
url	string Url link.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
}

Delete an attachment

Deleting an attachment by its unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Attachment unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Response samples

Content type

application/json

{"message": "string"
}

Get an attachment

Retrieving full information of an attachment by its unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Attachment unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (AttachmentResource)

Full information related to the attachment.

caption	string Attachment caption
created_at	string <date-time> Date and time of creation.
downloadUrl	string Download link.
extension	string Attachment extension
id	integer Unique identifier.
size	integer Attachment size
type	string Attachment type.
updated_at	string <date-time> Date and time of modification.
url	string Url link.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
}

Download attachment

Download an attachment by its unique identifier.

Authorizations:

x-api-key

path Parameters

id

required

integer

Attachment unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Response samples

404
419
422
500

Content type

application/json

{"message": "Not Found. The resource you requested could not be located."
}

AttachmentEntity

A tag that represents the continuation of working with attachments. After successfully creating an attachment, you need to link it to entities that support attachments, such as clients, correspondence, etc.

Assigning an attachment to an entity

Endpoint responsible for directly creating the link between an attachment and an entity.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

attachment_id required	integer Attachment unique identifier
entity_type required	string Entity type, a short name for the entity type. For example, if you need to upload a file for a document or a client, you should specify "client" or "client_document" here
entity_id required	integer The ID of this entity. For example, if you need to retrieve all files related to a client, and the client has an ID of 111, you should specify 111 here.

Responses

Response Schema: application/json

object (AttachmentResource)

Full information related to the attachment.

caption	string Attachment caption
created_at	string <date-time> Date and time of creation.
downloadUrl	string Download link.
extension	string Attachment extension
id	integer Unique identifier.
size	integer Attachment size
type	string Attachment type.
updated_at	string <date-time> Date and time of modification.
url	string Url link.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"attachment_id": 0,
"entity_id": 0,
"entity_type": "string"
}

Response samples

Content type

application/json

{"data": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
}

Remove an attachment from an entity

Removing the link between an attachment and an entity. Note that if the attachment has no other links, this endpoint will also delete the attachment itself.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Attachment unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

entity_type required	string Entity type, a short name for the entity type. For example, if you need to upload a file for a document or a client, you should specify "client" or "client_document" here
entity_id required	integer The ID of this entity. For example, if you need to retrieve all files related to a client, and the client has an ID of 111, you should specify 111 here.

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"entity_id": 0,
"entity_type": "string"
}

Response samples

Content type

application/json

{"message": "string"
}

Authentication

Endpoints related to site authentication.

User login

User login to the site.

Authorizations:

x-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

email required	string <email> Email address of the user
password required	string Password of the user

Responses

Response Schema: application/json

token	string Generated token for authentication
	object (User) User object

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"password": "string"
}

Response samples

Content type

application/json

{"token": "string",
"user": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
}
}

Refresh JWT token

Updating the JWT token. When your token has expired or is still active, you can refresh it, thereby extending its lifespan.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

token	string Generated token for authentication
	object (User) User object

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

message

string

Response samples

200
401
419
500

Content type

application/json

{"token": "string",
"user": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
}
}

User Login Socialite Provider

Log in user with socialite providers e.g. Azure, AWS, etc.

Authorizations:

x-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

code required	string Callback code
provider required	string Value: "azure" Provider name

Responses

Response Schema: application/json

token	string Generated token for authentication
	object (User) User object

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"code": "string",
"provider": "azure"
}

Response samples

Content type

application/json

{"token": "string",
"user": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
}
}

ResetPassword

Endpoints related to user password recovery and reset.

Send password recovery instructions.

Start the password recovery process and send a notification with a instructions to reset the password.

Authorizations:

x-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

email

required

string <email>

Email address of the user

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"email": "user@example.com"
}

Response samples

Content type

application/json

{"message": "string"
}

Reset password.

Changing the user's password. Used after receiving the password recovery instructions.

Authorizations:

x-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

email required	string <email> Email address of the user
password required	string New password of the user
token required	string The token received for password recovery from the instructions.
password_confirmation required	string Confirm Password of the user

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"password": "string",
"password_confirmation": "string",
"token": "string"
}

Response samples

Content type

application/json

{"message": "string"
}

Bureau Address

Operations for managing Bureau Addresses. These endpoints allow staff to create, retrieve, update, and delete bureau addresses. Allowed types - equifax, experian, transunion

Get a Bureau Addresses

Retrieve a paginated list of Bureau Addresses with filtering and sorting options.

Authorizations:

bearerAuthx-api-key

query Parameters

search	string Search query (e.g. value of: title, type, address etc.)
id	integer ID of the Bureau
type	string Type of the Bureau
state	string State of the Bureau
city	string City of the Bureau
is_default	boolean Is default
sort_by	string Sort column field (e.g., title, type, address, etc.)
sort_direction	string Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Page number (e.g., 1)
per_page	integer Items per page (e.g., 10)

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

Array

address	string Physical address of Bureau
city	string Name of City of Bureau
created_at	string <date-time> Created at
id	integer ID
is_default	boolean Flag indicating the default address (used in the workflow "Generate Letter")
state	string State of Bureau
title	string Bureau title
type	string Bureau type
updated_at	string <date-time> Updated at
zip_code	integer ZIP code of Bureau

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

[{"address": "string",
"city": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_default": true,
"state": "string",
"title": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"zip_code": 0
}
]

Create a Bureau Address

Creates a new Bureau Address with related fields (except is_default)

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to create a new BureauAddress

address	string <= 255 characters Physical Address of the Bureau
city	string <= 255 characters Name of City of the Bureau
fax_number	string <= 20 characters Fax number of the Bureau
state	string <= 100 characters state of the Bureau
title	string <= 255 characters Name of the Bureau
type	string Type of the Bureau
zip_code	integer Zip code of the Bureau

Responses

Response Schema: application/json

object (BureauAddressResponse)

address	string Physical address of Bureau
city	string Name of City of Bureau
created_at	string <date-time> Created at
id	integer ID
is_default	boolean Flag indicating the default address (used in the workflow "Generate Letter")
state	string State of Bureau
title	string Bureau title
type	string Bureau type
updated_at	string <date-time> Updated at
zip_code	integer ZIP code of Bureau

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"address": "string",
"city": "string",
"fax_number": "string",
"state": "string",
"title": "string",
"type": "string",
"zip_code": 0
}

Response samples

Content type

application/json

{"data": {"address": "string",
"city": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_default": true,
"state": "string",
"title": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"zip_code": 0
}
}

Delete Bureau Address

Delete Bureau Address by specified unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Bureau Address unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Update Bureau Address

Update the content of an existing internal Bureau Address

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Bureau Address id

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to update an existing Bureau Address

address	string <= 255 characters Physical Address of the Bureau
city	string <= 255 characters Name of City of the Bureau
fax_number	string <= 20 characters Fax number of the Bureau
is_default	boolean Default: false Flag indicating the default address (used in the workflow "Generate Letter")
state	string <= 100 characters state of the Bureau
title	string <= 255 characters Name of the Bureau
type	string Type of the Bureau
zip_code	integer Zip code of the Bureau

Responses

Response Schema: application/json

address	string Physical address of Bureau
city	string Name of City of Bureau
created_at	string <date-time> Created at
id	integer ID
is_default	boolean Flag indicating the default address (used in the workflow "Generate Letter")
state	string State of Bureau
title	string Bureau title
type	string Bureau type
updated_at	string <date-time> Updated at
zip_code	integer ZIP code of Bureau

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"address": "string",
"city": "string",
"fax_number": "string",
"is_default": false,
"state": "string",
"title": "string",
"type": "string",
"zip_code": 0
}

Response samples

Content type

application/json

{"address": "string",
"city": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_default": true,
"state": "string",
"title": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"zip_code": 0
}

ClientAgreements

API Endpoints for managing client agreements

Get client agreements list

Get client agreements list by filters and pagination

Authorizations:

bearerAuthx-api-key

query Parameters

client_id required	integer Client id
name	string Filter by name
type	string Filter by type
author_id	integer Author (User) id
sort_by	string Default: "id" Sort by field (id, created_at)
sort_direction	string Default: "desc" Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Default: 1 Page number
per_page	integer Default: 15 Items per page

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

Array

agreement_signed	string <date-time>
	object (AttachmentResource) Full information related to the attachment.
	object (User) User object
	object
created_at	string <date-time>
id	integer
name	string
type	string
updated_at	string <date-time>

Response samples

200

Content type

application/json

[{"agreement_signed": "2019-08-24T14:15:22Z",
"attachment": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"client": {"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"id": "id",
"name": "name",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
]

Create client agreement

Create a new client agreement for a client

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

name required	string Agreement name
type required	string Agreement type
agreement_signed	string <date-time> Agreement signed date (format: Y-m-d H:i:s)
attachment_id	integer Attachment ID
client_id	integer Client ID
contract_id	integer Contract ID

Responses

Response Schema: application/json

agreement_signed	string <date-time>
	object (AttachmentResource) Full information related to the attachment.
	object (User) User object
	object
created_at	string <date-time>
id	integer
name	string
type	string
updated_at	string <date-time>

Request samples

Payload

Content type

application/json

{"agreement_signed": "2024-03-25 14:30:00",
"attachment_id": 0,
"client_id": 0,
"contract_id": 0,
"name": "Name",
"type": "string"
}

Response samples

200

Content type

application/json

{"agreement_signed": "2019-08-24T14:15:22Z",
"attachment": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"client": {"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"id": "id",
"name": "name",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

Client

The API endpoints to view existing clients.

Get client list

Get client list by specified conditions like search, sort, pagination, etc.

Authorizations:

bearerAuthx-api-key

query Parameters

search	string Search query by field value (e.g. value from: FirstName, MiddleName, LastName, Email,MobilePhone, Phone, HomePhone). For example you enter Test1 and if a Client with such FirstName or MiddleName or LastName or partially Email is found the system will show it.
sort_by	string Field to sort by a specific column (e.g. id, FirstName, MiddleName, LastName, Email, MobilePhone, Phone, HomePhone).
sort_direction	string Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Page number (e.g., 1)
per_page	integer Items per page (e.g., 10)

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (ClientResourceCollection)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"data": [{"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
}
],
"links": {"first": "string",
"last": "string",
"next": "string",
"prev": "string"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "string"
}
],
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get clients list by conditions

Get client list based on the specified complex conditions.

Authorizations:

bearerAuthx-api-key

query Parameters

sort_by	string Field to sort by a specific column(e.g., id, FirstName, MiddleName, LastName, Email, MobilePhone, Phone, HomePhone)
sort_direction	string Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Page number (e.g., 1)
per_page	integer Items per page (e.g., 10)

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

combinator	string Enum: "AND" "OR" Condition combinator.
	object (SegmentRuleGroup) A group of rules for filtering clients in a segment
segment_id	integer Segment ID

Responses

Response Schema: application/json

Array

	Array of objects (Client) Array of Clients with attributes
	object Pagination links
	object Pagination metadata

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"combinator": "AND",
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"segment_id": 0
}

Response samples

Content type

application/json

[{"data": [{"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
}
],
"links": {"first": "string",
"last": "string",
"next": "string",
"prev": "string"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "string"
}
],
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}
]

Get a client

Retrieving full information of a client by its unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Client unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	object Dynamic client attributes
client_key	string or null Unique client key
email	string Email of client
id	integer ID in Client model
joint_customer_sf_id	string Joint Customer Salesforce ID (Only for old clients)
mobile_phone	string Mobile phone of client
salesforce_id	integer Salesforce ID in Client model
	object (SegmentResource) Segment resource representation
ssn	integer Social Security Number of client

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
}

ClientDocument

API Endpoints for managing client documents.

Get client document list

Retrieving all documents related to the specified client in the parameters (client_id).

Authorizations:

bearerAuthx-api-key

query Parameters

client_id required	integer Client unique identifier
type	string Enum: "id" "credit_related" "fixed_income_verification" "other" Filtering documents by type.
subtype	string Enum: "drive_licence" "bank_or_credit_union_statement" "canceled_check" "government_issued_id" "signed_letter_from_homeless_shelter" "stamped_post_office_box_receipt" "utility_bills" "pay_stub" "other" "transunion" "equifax" "experian" "creditor" Filtering documents by subtype.
author_id	integer Unique identifier of the document author (the user who uploaded the document).
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (Client Document)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"attachment": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"subtype": "drive_licence",
"type": "id",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Link an attachment as a client document

Link the uploaded attachment as a client document.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

type required	string Enum: "id" "credit_related" "fixed_income_verification" "other" Filtering documents by type.
attachment_id required	integer Attachment unique identifier
client_id	integer Client unique identifier
subtype	string Enum: "drive_licence" "bank_or_credit_union_statement" "canceled_check" "government_issued_id" "signed_letter_from_homeless_shelter" "stamped_post_office_box_receipt" "utility_bills" "pay_stub" "other" "transunion" "equifax" "experian" "creditor" Filtering documents by subtype.

Responses

Response Schema: application/json

object (Client Document)

Full information about the client document.

	object (AttachmentResource) Full information related to the attachment.
	object (User) User object
	object (Client) Client object
created_at	string <date-time> Date and time of creation.
subtype	string or null Document subtype.
type	string Document type.
updated_at	string <date-time> Date and time of modification.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"attachment_id": 0,
"client_id": 0,
"subtype": "drive_licence",
"type": "credit_related"
}

Response samples

Content type

application/json

{"data": {"attachment": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"subtype": "drive_licence",
"type": "id",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete client document

Deleting a client document. Note that if the attachment is no longer linked to any other entity, it will be immediately deleted.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Client Document unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Response samples

Content type

application/json

{"message": "Unauthenticated."
}

Retrieve details of a client document

Retrieve details of a client document by its unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Client Document unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (Client Document)

Full information about the client document.

	object (AttachmentResource) Full information related to the attachment.
	object (User) User object
	object (Client) Client object
created_at	string <date-time> Date and time of creation.
subtype	string or null Document subtype.
type	string Document type.
updated_at	string <date-time> Date and time of modification.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"attachment": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"subtype": "drive_licence",
"type": "id",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update client document

Update a client document by its unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Client Document unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

attachment_id

required

integer

Attachment unique identifier

Responses

Response Schema: application/json

object (Client Document)

Full information about the client document.

	object (AttachmentResource) Full information related to the attachment.
	object (User) User object
	object (Client) Client object
created_at	string <date-time> Date and time of creation.
subtype	string or null Document subtype.
type	string Document type.
updated_at	string <date-time> Date and time of modification.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"attachment_id": 0
}

Response samples

Content type

application/json

{"data": {"attachment": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"subtype": "drive_licence",
"type": "id",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Clients Goals

A tag that represents a continuation of the goal work. Once you have successfully created a goal, you can link it to the client to define their goals.

Remove a goal from a client

Remove a goal from a client by unique identifiers

Authorizations:

bearerAuthx-api-key

path Parameters

client

required

integer

Example: 1

Client unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Payload containing an array of goal IDs to disallow to the client

goal_ids

required

Array of integers

Array of Goal IDs

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"goal_ids": [2
]
}

Response samples

401
403
419
422
500

Content type

application/json

{"message": "Unauthenticated."
}

Retrieve all goals assigned to a client

Retrieve all goals assigned to a client by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

client

required

integer

Example: 1

Client unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (GoalResponse)

created_at	string <date-time> Created at
icon	string Goal icon
id	integer ID
name	string Goal name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"icon": "string",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Assign multiple goals to a client

Assign multiple existing goals to a client by unique identifiers

Authorizations:

bearerAuthx-api-key

path Parameters

client

required

integer

Example: 1

Client ID

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Payload containing an array of goal IDs to assign to the client

goal_ids

required

Array of integers

Array of Goal IDs

Responses

Response Schema: application/json

object (GoalResponse)

created_at	string <date-time> Created at
icon	string Goal icon
id	integer ID
name	string Goal name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"goal_ids": [2
]
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"icon": "string",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

ClientReport

Operations for managing and retrieving client internal credit reports from various bureaus.

Get all client reports

Retrieves all internal credit reports associated with a specific client identified by their unique identifier. Returns report data from all bureaus that have reports for this client.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Client unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

Array

bureau	string Name of bureau
client_id	integer ID
created_at	string <date-time> Created at
id	integer ID
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

[{"bureau": "string",
"client_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
]

Get client report

Retrieves a specific credit report for a client from a particular credit bureau.This endpoint allows you to access detailed report information from a single bureau (TransUnion, Equifax, or Experian) for a specific client.

Authorizations:

bearerAuthx-api-key

path Parameters

id required	integer Client unique identifier
bureau required	string Enum: "transunion" "equifax" "experian" Credit bureau identifier that specifies which bureau`s report to retrieve.Must be one of: transunion (TransUnion), equifax (Equifax), or experian (Experian).

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

bureau	string Name of bureau
client_id	integer ID
created_at	string <date-time> Created at
id	integer ID
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"bureau": "string",
"client_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"updated_at": "2019-08-24T14:15:22Z"
}

ClientProduct

API Endpoints for managing Client Products.

Get Client Product list

Retrieving all Products related to the specified Client in the parameters (client_id).

Authorizations:

bearerAuthx-api-key

query Parameters

client_id	integer Client unique identifier
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (Client Product)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"charged_monthly": 0.1,
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"initial_fee": 0.1,
"product": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"product_code": "string",
"product_type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Retrieve details of a Client Product

Retrieve details of a Client Product by its unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Client Product unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (Client Product)

Full information about the Client Product.

charged_monthly	number <float> Charged Monthly
	object (Client) Client object
created_at	string <date-time> Date and time of creation.
initial_fee	number <float> Initial Fee
	object (ProductResponse)
updated_at	string <date-time> Date and time of modification.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"charged_monthly": 0.1,
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"initial_fee": 0.1,
"product": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"product_code": "string",
"product_type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"updated_at": "2019-08-24T14:15:22Z"
}
}

ClientKbaAuthentication

Endpoints related to KBA (Knowledge-Based Authentication) authorization in various bureaus.

Get KBA questions

Retrieving questions from the bureau for completing KBA (Knowledge-Based Authentication) authorization.

Authorizations:

bearerAuthx-api-key

path Parameters

id required	integer Client unique identifier
provider required	string Enum: "array_transunion" "array_equifax" "array_experian" "spin_wheel" "id_iq" Provider name

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

Array

auth_method	string Auth method (KBA/SMFA/OPT)
auth_token	string The client's auth token, necessary for internal operations, passes through from the question to the answer.
	Array of objects (Question) The actual list of questions with answers.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

200
401
403
419
500

Content type

application/json

[{"auth_method": "string",
"auth_token": "string",
"questions": [{"answers": [{"id": "string",
"text": "string"
}
],
"id": "string",
"text": "string"
}
]
}
]

Answer KBA questions

Endpoint designed for answering KBA (Knowledge-Based Authentication) questions.

Authorizations:

bearerAuthx-api-key

path Parameters

id required	integer Client unique identifier
provider required	string Enum: "array_transunion" "array_equifax" "array_experian" "spin_wheel" "id_iq" Provider name

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

required	Array of objects List of answers to KBA (Knowledge-Based Authentication) questions.
auth_pin	string The AUZ pin, required when the client needs to enter a pin (OPT) received.
auth_token	string The authorization token obtained in the previous step.

Responses

Response Schema: application/json

Array

auth_method	string Auth method (KBA/SMFA/OPT)
auth_token	string The client's auth token, necessary for internal operations, passes through from the question to the answer.
	Array of objects (Question) The actual list of questions with answers.

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"answers": [{"answerId": "222",
"questionId": "111"
}
],
"auth_pin": "string",
"auth_token": "string"
}

Response samples

Content type

application/json

[{"auth_method": "string",
"auth_token": "string",
"questions": [{"answers": [{"id": "string",
"text": "string"
}
],
"id": "string",
"text": "string"
}
]
}
]

Skip KBA authorization

Endpoint designed for artificial client authorization in the bureau, bypassing KBA (Knowledge-Based Authentication) authorization.

Authorizations:

bearerAuthx-api-key

path Parameters

id required	integer Client unique identifier
provider required	string Enum: "id_iq" "spin_wheel" "array_transunion" "array_equifax" "array_experian" Provider name

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

message

string

Response samples

200
401
403
419
500

Content type

application/json

{"message": "string"
}

Clients Segments

Operation for getting client segments. Client segments are used to define groups of clientsbased on specific conditions, enabling targeted workflow triggers and step conditions.

Get client segments

Retrieve all segments assigned to a client based on segmentation rules and conditions

Authorizations:

bearerAuthx-api-key

path Parameters

client

required

integer

Example: 1

Client unique identifier used to retrieve all segments associated withthis specific client. This ID is used to filter segments that have been assigned to the client based on defined segmentation rules.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (SegmentResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Task

The API endpoints to view tasks for the clients.

Get task list

Get Client task list by filters and pagination

Authorizations:

bearerAuthx-api-key

query Parameters

client_id required	integer Client unique identifier
search	string Search by name and description
status	string Task status
due_date	string <date-time> Due date
author_id	integer Author unique identifier
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (TaskResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"due_date": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"resource_id": "string",
"resource_type": "string",
"status": "string",
"updated_at": "2019-08-24T14:15:22Z",
"workflow_step": {"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": null,
"completion_status": null,
"createdBy": null,
"created_at": null,
"description": null,
"exit_on_trigger_mismatch": null,
"id": null,
"is_active": null,
"is_archive": null,
"is_version": null,
"lastModifiedBy": null,
"max_duration": null,
"name": null,
"steps": [ ],
"trigger": null,
"type": null,
"updated_at": null,
"workflowInstances": [ ],
"workflowNotes": [ ]
}
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
},
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
}
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": null
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": null
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Credit Report Master Schemas

Get credit report master schema with content

Retrieve a specific credit report master schema with S3 file content

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Example: 1

Credit report master schema ID

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (CreditReportMasterSchemaWithContentResource)

bureau	string Credit bureau
	object (Client) Client object
client_key	string Client key
	object JSON content from S3 file
id	integer Credit report master schema ID
internal_client_key	string Internal client key
modified_date	string <date-time> Last modified date
report_date	string <date> Report date
report_id	string Credit report ID
vendor	string Credit report vendor

Response samples

200

Content type

application/json

{"data": {"bureau": "EFX",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "CK_456",
"content": {"items": [ ],
"schema": "data"
},
"id": 1,
"internal_client_key": "CLIENT_123",
"modified_date": "2024-01-15T10:30:00Z",
"report_date": "2024-01-15",
"report_id": "RPT_789",
"vendor": "Equifax"
}
}

Get paginated list of credit report master schemas

Retrieve a paginated list of credit report master schemas for a specific client with optional filtering

Authorizations:

bearerAuthx-api-key

path Parameters

client

required

integer

Client unique identifier

query Parameters

vendor	string Example: vendor=Equifax Credit report vendor
bureau	string Example: bureau=EFX Credit bureau
report_date	string <date> Example: report_date=2024-01-01 Report date
report_id	integer Example: report_id=1 Specific report ID
per_page	integer [ 1 .. 100 ] Example: per_page=15 Items per page
page	integer >= 1 Example: page=1 Page number
sort_by	string Example: sort_by=report_date Sort by field
sort_direction	string Enum: "asc" "desc" Example: sort_direction=desc Sort direction

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (CreditReportMasterSchemaResource)
links	object
meta	object

Response samples

200

Content type

application/json

{"data": [{"available_file_types": ["master_schema",
"negative_items"
],
"bureau": "EFX",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "CK_456",
"id": 1,
"internal_client_key": "CLIENT_123",
"modified_date": "2024-01-15T10:30:00Z",
"report_date": "2024-01-15",
"report_id": "RPT_789",
"vendor": "Equifax"
}
],
"links": { },
"meta": { }
}

Get latest credit report master schema with content

Retrieve the latest credit report master schema with S3 file content for a specific client

Authorizations:

bearerAuthx-api-key

path Parameters

client

required

integer

Client unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (CreditReportMasterSchemaWithContentResource)

bureau	string Credit bureau
	object (Client) Client object
client_key	string Client key
	object JSON content from S3 file
id	integer Credit report master schema ID
internal_client_key	string Internal client key
modified_date	string <date-time> Last modified date
report_date	string <date> Report date
report_id	string Credit report ID
vendor	string Credit report vendor

Response samples

200

Content type

application/json

{"data": {"bureau": "EFX",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "CK_456",
"content": {"items": [ ],
"schema": "data"
},
"id": 1,
"internal_client_key": "CLIENT_123",
"modified_date": "2024-01-15T10:30:00Z",
"report_date": "2024-01-15",
"report_id": "RPT_789",
"vendor": "Equifax"
}
}

Negative Items

API endpoints for managing negative credit items and their metadata.

Get negative items list

Get a filtered list of negative credit items with optional metadata filtering by status, dispute flags, and other criteria.

Authorizations:

bearerAuthx-api-key

query Parameters

client_id	integer Filter by specific client ID
account_type	string Filter by account type
is_negative	boolean Filter by negative status
is_collection	boolean Filter by collection status
is_charge_off	boolean Filter by charge-off status
is_disputed	boolean Filter by dispute status
status	string Enum: "new" "not_processed" "in_progress" "repaired" Filter by metadata status
sort_by	string Field to sort by
sort_direction	string Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Page number (e.g., 1)
per_page	integer Items per page (e.g., 10)

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (Negative Item Resource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

200
401
403
422
500

Content type

application/json

{"data": [{"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get a negative item

Retrieve detailed information about a specific negative credit item including its metadata and associated client information.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Negative item unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (Negative Item Resource)

A negative credit item with all financial and metadata information

account_name	string Account name
account_number	string Account number
account_ownership_type	string or null Account ownership type
account_paid_date	string or null <date> Account paid date
account_status	string Current account status
account_type	string Type of account
bureau_tradeline_id	string Bureau tradeline ID
charge_off_date	string or null <date> Charge-off date
	object (Client) Client object
client_key	string Client unique key
close_date	string or null <date> Date account was closed
collection_date	string or null <date> Collection date
	Array of objects (CorrespondenceResponse) List of related correspondence
credit_balance	string or null Credit balance
credit_limit	string or null Credit limit
credit_loan_type	string or null Credit loan type
credit_report_id	integer Credit report ID
current_rateing_code	string or null Current rating code
current_rating_type	string or null Current rating type
high_balance_amount	string or null High balance amount
high_credit_amount	string or null High credit amount
highest_adverse_rating_code	string or null Highest adverse rating code
highest_adverse_rating_type	string or null Highest adverse rating type
internal_client_key	string Internal client key
is_charge_off	boolean Whether item is charged off
is_closed	boolean Whether account is closed
is_collection	boolean Whether item is in collection
is_disputed	boolean Whether item is disputed
is_mortgage	boolean Whether item is a mortgage
is_negative	boolean Whether item is negative
is_revolving	boolean Whether item is revolving credit
is_secure_loan	boolean Whether item is a secure loan
last_activity_date	string or null <date> Last activity date
last_payment_date	string or null <date> Last payment date
late_count_30_days	integer or null Count of 30-day late payments
late_count_60_days	integer or null Count of 60-day late payments
late_count_90_days	integer or null Count of 90-day late payments
loan_type	string or null Type of loan
	object (Negative Item Metadata Resource) Metadata information for a negative credit item including status and dispute flags
modified_date	string <datetime> Last modified date
monthly_payment	string or null Monthly payment amount
months_viewed	integer or null Months viewed
most_recent_adverse_rating_code	string or null Most recent adverse rating code
most_recent_adverse_rating_date	string or null <date> Most recent adverse rating date
most_recent_adverse_rating_type	string or null Most recent adverse rating type
opened_date	string <date> Date account was opened
original_balance_amount	string or null Original balance amount
past_due_amount	string or null Past due amount
report_id	string Report identifier
reported_date	string <date> Date last reported
terms_desc	string or null Terms description
terms_month	integer or null Terms in months
unpaid_balance_amount	string or null Unpaid balance amount
vendor_tradeline_id	string Vendor tradeline ID

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

200
401
403
404
500

Content type

application/json

{"data": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
}
}

Contract

Operations for managing contracts. Contracts can be created, updated, cloned, and versioned.They support shortcode parsing for dynamic content using Snippets and Variables.

Get a list of contracts

Returns a paginated and sortable list of contracts.Supports searching by name and includes related Products entity information.

Authorizations:

bearerAuthx-api-key

query Parameters

name	string Name of Contract
created_at	string Example: created_at=2025-01-01 Created at (YYYY-MM-DD)
product_id	integer Example: product_id=1 Related Products ID
per_page	integer Items per page (e.g., 10)
page	integer Page number
sort_by	string Sort by
sort_direction	string Enum: "asc" "desc" Sort direction

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (ContractResponse)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"name": "string",
"product": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create a new Contract

Creates a new contract and associates it with a Products entity.The content field supports shortcodes in the format [Test] that will be replaced with valuesfrom Variables or Snippets. Note: If there are shortcodes with the same names,Variables take priority over Snippets for parsing.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

content	string Content of the contract
description	string description of the contract
name	string shortcode without brackets
product_id	integer related Products ID
type	string type of the contract

Responses

Response Schema: application/json

object (ContractResponse)

content	string Content of the contract
created_at	string <date-time> Created at
description	string description of the Contract
id	integer ID
name	string shortcode without brackets
	object related Products data
type	string type of the Contract
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"content": "Some contract content",
"description": "Description of the contract",
"name": "string",
"product_id": 0,
"type": "Terms of agreement"
}

Response samples

Content type

application/json

{"data": {"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"name": "string",
"product": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete a contract

Permanently removes a contract and its associated versions from the system.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Unique identifier of the contract to delete

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Get a specific contract

Returns a specific contract by ID with its content field parsed (shortcodes replaced with actual values). Includes information from the attached Product entity if one exists

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Unique identifier of the contract to retrieve

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (ContractResponse)

content	string Content of the contract
created_at	string <date-time> Created at
description	string description of the Contract
id	integer ID
name	string shortcode without brackets
	object related Products data
type	string type of the Contract
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"name": "string",
"product": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update an existing Contract

Updates a contract by ID and automatically creates a new version with the current timestamp.Each update is tracked in the version history with the author information.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Contract id

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to update an existing Contract

content	string Content of the contract
description	string description of the contract
name	string shortcode without brackets
product_id	integer related Products ID
type	string type of the contract

Responses

Response Schema: application/json

object (ContractResponse)

content	string Content of the contract
created_at	string <date-time> Created at
description	string description of the Contract
id	integer ID
name	string shortcode without brackets
	object related Products data
type	string type of the Contract
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"content": "Some contract content",
"description": "Description of the contract",
"name": "string",
"product_id": 0,
"type": "Terms of agreement"
}

Response samples

Content type

application/json

{"data": {"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"name": "string",
"product": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Clone an existing Contract

Clone a contract by ID with automatic name generation. Creates a copy of an existing contract with a new automatically generated name. The naming follows the pattern "Copy {original_name}" with numeric suffixes (1, 2, etc.)added if needed to ensure uniqueness.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Unique identifier of the contract to clone

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (ContractResponse)

content	string Content of the contract
created_at	string <date-time> Created at
description	string description of the Contract
id	integer ID
name	string shortcode without brackets
	object related Products data
type	string type of the Contract
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"name": "string",
"product": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get contract versions

Retrieve version history for a contract. Returns a list of all versions for a specific contract in descending order by creation time. Each version includes the content at that point in time andinformation about the author who made the changes.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Unique identifier of the contract whose versions to retrieve

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (ContractVersionResponse)

	object Author ID of the version
content	string Content of the contract version
contract_id	integer Related Contract ID
created_at	string <date-time> Creation timestamp
id	integer Version ID
version_number	string Version number (e.g., date-based YmdHis format)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"author_id": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"content": "string",
"contract_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"version_number": "20250325104546"
}
}

Revert a contract to a previous version

Reverts a contract to a previous state by selecting a specific version. The contract contentwill be updated to match the content from the selected version while creating a new version entry in the history.

Authorizations:

bearerAuthx-api-key

path Parameters

id required	integer Unique identifier of the contract to revert
version_id required	integer Unique identifier of the version to revert to

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

Array

	object Author ID of the version
content	string Content of the contract version
contract_id	integer Related Contract ID
created_at	string <date-time> Creation timestamp
id	integer Version ID
version_number	string Version number (e.g., date-based YmdHis format)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

[{"author_id": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"content": "string",
"contract_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"version_number": "20250325104546"
}
]

Correspondence

Operations for retrieving client correspondence including fax, email, SMS, and letters. (For Customer Portal)

Get correspondence list

Get correspondence list with filtering, searching, and pagination options

Authorizations:

bearerAuthx-api-key

query Parameters

type	string Enum: "fax" "email" "sms" "letter" Type of correspondence. Allowed values: fax, email, sms, letter.
client_id	integer Client unique identifier.
run_by	integer Fax sender (User) unique identifier
recipient	string Fax Recipient
fax_number	string Fax number
negative_item_id	integer Filter by linked NegativeItem ID
search	string Search query (e.g. value of: created_at, subject, run_by etc.)
sort_by	string Sort column field (e.g., created_at, subject, first_name etc.)
sort_direction	string Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Page number (e.g., 1)
per_page	integer Items per page (e.g., 10)

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (CorrespondenceResponse)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create a new correspondence

Create a new correspondence (only fax available now). Must include either recipient or furnisher, but not both, and always fax_number.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data for creating a new correspondence

client_id required	integer ID of the client
type required	string Value: "fax" Type of correspondence. Only "fax" is allowed for creation.
attachment_id	integer Attachment ID associated with the correspondence (optional)
	object or object Must include either `recipient` or `furnisher`, but not both, and always `fax_number`.

Responses

Response Schema: application/json

object (CorrespondenceResponse)

Correspondence object

	Array of objects Attachments of correspondence
	Array of objects Dynamic correspondence attributes
client_id	integer Client ID
id	integer Correspondence ID
negative_item_id	integer Linked negative item ID, if available
	object User who created the correspondence
type	string Correspondence type

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"attachment_id": 0,
"attributes": {"fax_number": "string",
"furnisher": "string",
"recipient": "string"
},
"client_id": 0,
"type": "fax"
}

Response samples

Content type

application/json

{"data": {"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
}

Send a correspondence

Send a correspondence by specific provider

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data for sending correspondence

type required	string Type of correspondence
client_id	integer ID of the client
	object
	object or object Must include fax_number and either recipient or furnisher, but not both.
	object
negative_item_id	integer or null Optional related negative item ID
	object

Responses

Response Schema: application/json

object (SendCorrespondenceResponse)

	object (CorrespondenceResponse) Correspondence object
message	string

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"client_id": 0,
"email": {"body": "Hello, welcome to our platform!",
"subject": "Welcome!",
"to": "test@nomail.com"
},
"fax": {"attachment_id": 0,
"fax_number": "string",
"furnisher": "Some furnisher",
"recipient": "string"
},
"letter": {"content": "Some letter text",
"postal_address": "Baker st. 221b"
},
"negative_item_id": 0,
"sms": {"body": "Some message text",
"number": "0(987)654321",
"tfn_id": "TFN5"
},
"type": "email"
}

Response samples

Content type

application/json

{"data": {"data": {"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
},
"message": "Fax sent successfully"
}
}

FaxSetting

Operations for managing fax settings. These endpoints allow administrators to configure, view, and update system-wide fax settings such as reattempt counts for failed fax transmissions.

Get fax settings list

Get fax settings list by query parameters and pagination

Authorizations:

bearerAuthx-api-key

query Parameters

reattempt_count	string Search by reattempt (e.g., 1, 2, 3)
sort_by	string Sort column field (e.g., id, reattempt_count)
sort_direction	string Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Page number (e.g., 1)
per_page	integer Items per page (e.g., 10)

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (FaxSettingsResponse)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"reattempt_count": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create fax settings

Create a new fax settings with reattempt count

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to create a new fax settings

reattempt_count

integer

Reattempt count

Responses

Response Schema: application/json

object (FaxSettingsResponse)

fax settings object

created_at	string <date-time> fax settings created at
id	integer fax settings ID
reattempt_count	integer Reattempt count
updated_at	string <date-time> fax settings updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"reattempt_count": 3
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"reattempt_count": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update fax settings

Update an existing fax settings with reattempt count

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

FaxSetting id

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

reattempt_count

required

integer

Reattempt count

Responses

Response Schema: application/json

object (FaxSettingsResponse)

fax settings object

created_at	string <date-time> fax settings created at
id	integer fax settings ID
reattempt_count	integer Reattempt count
updated_at	string <date-time> fax settings updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"reattempt_count": 0
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"reattempt_count": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
}

CustomerIo Templates

API endpoints to view all existing CustomerIo Templates.

Get all CustomerIo Templates

Get all existing CustomerIo Templates list with their full information.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects
message	string

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"created_at": 1672248195,
"description": "",
"hide_message_body": false,
"id": 1,
"link_tracking": true,
"name": "All uncategorized email messages",
"open_tracking": true,
"queue_drafts": false,
"send_to_unsubscribed": true,
"trigger_name": "",
"updated_at": 1672248195
}
],
"message": "CustomerIo Templates fetched successfully"
}

Customer - Client Agreements

API Endpoints for managing Client Agreements (for Customer Portal)

Create Client Agreement

Create a new Agreement for a Client (for Customer Portal)

Authorizations:

CustomerBearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

name required	string Agreement name
type required	string Agreement type
agreement_signed	string <date-time> Agreement signed date (format: Y-m-d H:i:s)
attachment_id	integer Attachment ID
client_id	integer Client ID
contract_id	integer Contract ID

Responses

Response Schema: application/json

agreement_signed	string <date-time>
	object (AttachmentResource) Full information related to the attachment.
	object (User) User object
	object
created_at	string <date-time>
id	integer
name	string
type	string
updated_at	string <date-time>

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"agreement_signed": "2024-03-25 14:30:00",
"attachment_id": 0,
"client_id": 0,
"contract_id": 0,
"name": "Name",
"type": "string"
}

Response samples

Content type

application/json

{"agreement_signed": "2019-08-24T14:15:22Z",
"attachment": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"client": {"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"id": "id",
"name": "name",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve all Agreements assigned to a Client

Retrieve all Agreements assigned to specific Client by unique identifier (for Customer Portal)

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

client

required

integer

Example: 1

Client Unique Identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (Client Agreement)

Client Agreement

agreement_signed	string <date-time>
	object (AttachmentResource) Full information related to the attachment.
	object (User) User object
	object
created_at	string <date-time>
id	integer
name	string
type	string
updated_at	string <date-time>

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Response samples

Content type

application/json

{"data": {"agreement_signed": "2019-08-24T14:15:22Z",
"attachment": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"client": {"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"id": "id",
"name": "name",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Customer - Client

The API endpoints for Customer Portal Client data

Update a Clients data

Updates an existing Client data at Customer Portal.

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

client

required

integer

Client id

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Payload for updating a clients data

	object Dynamic attributes for the Client
email	string Clients Email
mobile_phone	string Clients Mobile Phone
ssn	string Clients SSN

Responses

Response Schema: application/json

object (Clients Negative Item)

Clients negative item

	object Dynamic Client Item attributes
id	integer
origin	string
status	string

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"attributes": {"D_O_B__c": "string",
"FirstName": "string",
"LastName": "string",
"MailingCity": "string",
"MailingPostalCode": 0,
"MailingState": "string",
"MailingStreet": "string",
"OtherCity": "string",
"OtherCountry": "string",
"OtherPostalCode": 0,
"OtherStreet": "string"
},
"email": "string",
"mobile_phone": "string",
"ssn": "string"
}

Response samples

Content type

application/json

{"data": {"attributes": {"item_type_equifax": "string",
"item_verify_flag_byclient": "string",
"payment_history": "string"
},
"id": "negative item id",
"origin": "manual",
"status": "Not Processed"
}
}

Get a client data (me)

Retrieving full information of a client by its unique identifier at Customer Portal.

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

id

required

integer

Client unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	object Dynamic client attributes
client_key	string or null Unique client key
email	string Email of client
id	integer ID in Client model
joint_customer_sf_id	string Joint Customer Salesforce ID (Only for old clients)
mobile_phone	string Mobile phone of client
salesforce_id	integer Salesforce ID in Client model
	object (SegmentResource) Segment resource representation
ssn	integer Social Security Number of client

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
}

Customer - Client Document

API Endpoints for managing client documents.(for Customer Portal)

Link an attachment as a client document

Link the uploaded attachment as a client document.(for Customer Portal)

Authorizations:

CustomerBearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

type required	string Enum: "id" "credit_related" "fixed_income_verification" "other" Filtering documents by type.
attachment_id required	integer Attachment unique identifier
client_id	integer Client unique identifier
subtype	string Enum: "drive_licence" "bank_or_credit_union_statement" "canceled_check" "government_issued_id" "signed_letter_from_homeless_shelter" "stamped_post_office_box_receipt" "utility_bills" "pay_stub" "other" "transunion" "equifax" "experian" "creditor" Filtering documents by subtype.

Responses

Response Schema: application/json

object (Client Document)

Full information about the client document.

	object (AttachmentResource) Full information related to the attachment.
	object (User) User object
	object (Client) Client object
created_at	string <date-time> Date and time of creation.
subtype	string or null Document subtype.
type	string Document type.
updated_at	string <date-time> Date and time of modification.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"attachment_id": 0,
"client_id": 0,
"subtype": "drive_licence",
"type": "credit_related"
}

Response samples

Content type

application/json

{"data": {"attachment": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"subtype": "drive_licence",
"type": "id",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update client document

Update a client document by its unique identifier.

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

id

required

integer <int64>

Client Document unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

attachment_id

required

integer

Attachment unique identifier

Responses

Response Schema: application/json

object (Client Document)

Full information about the client document.

	object (AttachmentResource) Full information related to the attachment.
	object (User) User object
	object (Client) Client object
created_at	string <date-time> Date and time of creation.
subtype	string or null Document subtype.
type	string Document type.
updated_at	string <date-time> Date and time of modification.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"attachment_id": 0
}

Response samples

Content type

application/json

{"data": {"attachment": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"subtype": "drive_licence",
"type": "id",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Retrieve all Documents related to a Client

Retrieving all documents related to specific Client by unique identifier (for Customer Portal) .

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

client

required

integer

Example: 1

Client Unique Identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (Client Document)

Full information about the client document.

	object (AttachmentResource) Full information related to the attachment.
	object (User) User object
	object (Client) Client object
created_at	string <date-time> Date and time of creation.
subtype	string or null Document subtype.
type	string Document type.
updated_at	string <date-time> Date and time of modification.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"attachment": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"subtype": "drive_licence",
"type": "id",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete client document

Deleting a client document. Note that if the attachment is no longer linked to any other entity, it will be immediately deleted.

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

client required	integer <int64> Client unique identifier
clientDocument required	integer <int64> Client Document unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Response samples

Content type

application/json

{"message": "Unauthenticated."
}

Customer - Clients Goals

Endpoints to manage a specific Clients Goals.

Remove a Goal from a specific Client (for Customer Portal)

Remove an existing Goal from an existing Client by unique identifiers (for Customer Portal)

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

client

required

integer

Clients Unique Identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Payload containing an array of existing Goal IDs to disallow to the client

goal_ids

required

Array of integers

Array of Goal IDs

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"goal_ids": [2
]
}

Response samples

401
403
419
422
500

Content type

application/json

{"message": "Unauthenticated."
}

Retrieve all goals assigned to a Client

Retrieve all goals assigned to a client by unique identifier (for Customer Portal)

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

client

required

integer

Example: 1

Client unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (GoalResponse)

created_at	string <date-time> Created at
icon	string Goal icon
id	integer ID
name	string Goal name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"icon": "string",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Assign multiple existing Goals to existing Client (for Customer Portal)

Assign multiple existing Goals to a Client by existing unique identifiers (for Customer Portal)

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

client

required

integer

Example: 1

Client Unique Identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Payload containing an array of existing Goal IDs to assign to the existing Client

goal_ids

required

Array of integers

Array of Goal IDs

Responses

Response Schema: application/json

object (GoalResponse)

created_at	string <date-time> Created at
icon	string Goal icon
id	integer ID
name	string Goal name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"goal_ids": [2
]
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"icon": "string",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Customer - Contract

API endpoints to view existing Contracts (at Customer Portal).

Get a list of contracts (at Customer Portal)

Returns a paginated and sortable list of contracts (at Customer Portal).Supports searching by name and includes related Products entity information.

Authorizations:

CustomerBearerAuthx-api-key

query Parameters

name	string Name of Contract
type	string Type of Contract
created_at	string Example: created_at=2025-01-01 Created at (YYYY-MM-DD)
product_id	integer Example: product_id=1 Related Products ID
per_page	integer Items per page (e.g., 10)
page	integer Page number
sort_by	string Sort by
sort_direction	string Enum: "asc" "desc" Sort direction

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (ContractResponse)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"name": "string",
"product": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get a specific contract

Returns a specific contract by ID with its content field parsed (shortcodes replaced with actual values). Includes information from the attached Product entity if one exists (at Customer Portal)

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

id

required

integer

Unique identifier of the contract to retrieve

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (ContractResponse)

content	string Content of the contract
created_at	string <date-time> Created at
description	string description of the Contract
id	integer ID
name	string shortcode without brackets
	object related Products data
type	string type of the Contract
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"name": "string",
"product": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Customer - Attachment

An attachment is an entity of a file. (for Customer Portal)

Upload an attachment at Customer portal

Uploading an attachment to create an entity and enable the attachment to be linked to client document at Customer portal

Authorizations:

CustomerBearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: multipart/form-data
required

file required	string <binary> File (jpg, jpeg, png, pdf, doc, docx)
caption	string or null Attachment caption

Responses

Response Schema: application/json

object (AttachmentResource)

Full information related to the attachment.

caption	string Attachment caption
created_at	string <date-time> Date and time of creation.
downloadUrl	string Download link.
extension	string Attachment extension
id	integer Unique identifier.
size	integer Attachment size
type	string Attachment type.
updated_at	string <date-time> Date and time of modification.
url	string Url link.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
}

Get an attachment by unique identifier

Retrieving full information of an attachment by its unique identifier.(for Customer Portal)

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

id

required

integer

Attachment unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (AttachmentResource)

Full information related to the attachment.

caption	string Attachment caption
created_at	string <date-time> Date and time of creation.
downloadUrl	string Download link.
extension	string Attachment extension
id	integer Unique identifier.
size	integer Attachment size
type	string Attachment type.
updated_at	string <date-time> Date and time of modification.
url	string Url link.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"downloadUrl": "string",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
}

Customer - Client Product

API Endpoints for retrieving Client Products.

Retrieve all Products related to a Client

Retrieving all products related to specific Client by unique identifier (for Customer Portal) .

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

client

required

integer

Example: 1

Client Unique Identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (Client Product)

Full information about the Client Product.

charged_monthly	number <float> Charged Monthly
	object (Client) Client object
created_at	string <date-time> Date and time of creation.
initial_fee	number <float> Initial Fee
	object (ProductResponse)
updated_at	string <date-time> Date and time of modification.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"charged_monthly": 0.1,
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"created_at": "2019-08-24T14:15:22Z",
"initial_fee": 0.1,
"product": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"product_code": "string",
"product_type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"updated_at": "2019-08-24T14:15:22Z"
}
}

Client Portal - Credit Report Master Schemas

Get paginated list of credit report master schemas for current client

Retrieve a paginated list of credit report master schemas for the authenticated client with optional filtering

Authorizations:

CustomerBearerAuthx-api-key

query Parameters

vendor	string Example: vendor=Equifax Credit report vendor
bureau	string Example: bureau=EFX Credit bureau
report_date	string <date> Example: report_date=2024-12-31 Report date
report_id	integer Example: report_id=1 Specific report ID
per_page	integer [ 1 .. 100 ] Example: per_page=15 Items per page
page	integer >= 1 Example: page=1 Page number
sort_by	string Example: sort_by=report_date Sort by field
sort_direction	string Enum: "asc" "desc" Example: sort_direction=desc Sort direction

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (CreditReportMasterSchemaResource)
links	object
meta	object

Response samples

200

Content type

application/json

{"data": [{"available_file_types": ["master_schema",
"negative_items"
],
"bureau": "EFX",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "CK_456",
"id": 1,
"internal_client_key": "CLIENT_123",
"modified_date": "2024-01-15T10:30:00Z",
"report_date": "2024-01-15",
"report_id": "RPT_789",
"vendor": "Equifax"
}
],
"links": { },
"meta": { }
}

Get latest credit report master schema with content for current client

Retrieve the latest credit report master schema with S3 file content for the authenticated client

Authorizations:

CustomerBearerAuthx-api-key

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (CreditReportMasterSchemaWithContentResource)

bureau	string Credit bureau
	object (Client) Client object
client_key	string Client key
	object JSON content from S3 file
id	integer Credit report master schema ID
internal_client_key	string Internal client key
modified_date	string <date-time> Last modified date
report_date	string <date> Report date
report_id	string Credit report ID
vendor	string Credit report vendor

Response samples

200

Content type

application/json

{"data": {"bureau": "EFX",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "CK_456",
"content": {"items": [ ],
"schema": "data"
},
"id": 1,
"internal_client_key": "CLIENT_123",
"modified_date": "2024-01-15T10:30:00Z",
"report_date": "2024-01-15",
"report_id": "RPT_789",
"vendor": "Equifax"
}
}

Get credit report master schema with content for current client

Retrieve a specific credit report master schema with S3 file content for the authenticated client

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

id

required

integer

Example: 1

Credit report master schema ID

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (CreditReportMasterSchemaWithContentResource)

bureau	string Credit bureau
	object (Client) Client object
client_key	string Client key
	object JSON content from S3 file
id	integer Credit report master schema ID
internal_client_key	string Internal client key
modified_date	string <date-time> Last modified date
report_date	string <date> Report date
report_id	string Credit report ID
vendor	string Credit report vendor

Response samples

200

Content type

application/json

{"data": {"bureau": "EFX",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "CK_456",
"content": {"items": [ ],
"schema": "data"
},
"id": 1,
"internal_client_key": "CLIENT_123",
"modified_date": "2024-01-15T10:30:00Z",
"report_date": "2024-01-15",
"report_id": "RPT_789",
"vendor": "Equifax"
}
}

Customer - Goal

API endpoints to view existing client goals (at Customer Portal).

Get all Goals (for Customer Portal)

Get all existing Goals list with their full information.(for Customer Portal)

Authorizations:

CustomerBearerAuthx-api-key

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (GoalResponse)

created_at	string <date-time> Created at
icon	string Goal icon
id	integer ID
name	string Goal name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"icon": "string",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Customer Portal Negative Items

API endpoints for managing negative credit items and their metadata.

Get negative items list

Get a filtered list of negative credit items with optional metadata filtering by status, dispute flags, and other criteria.

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

client

required

integer

Example: 1

Client Unique Identifier

query Parameters

account_type	string Filter by account type
is_negative	boolean Filter by negative status
is_collection	boolean Filter by collection status
is_charge_off	boolean Filter by charge-off status
is_disputed	boolean Filter by dispute status
status	string Enum: "new" "not_processed" "in_progress" "repaired" Filter by metadata status
sort_by	string Field to sort by
sort_direction	string Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Page number (e.g., 1)
per_page	integer Items per page (e.g., 10)

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (Negative Item Resource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

200
401
403
422
500

Content type

application/json

{"data": [{"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get a negative item

Retrieve detailed information about a specific negative credit item including its metadata and associated client information.

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

client required	integer Example: 1 Client Unique Identifier
id required	integer Negative item unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (Negative Item Resource)

A negative credit item with all financial and metadata information

account_name	string Account name
account_number	string Account number
account_ownership_type	string or null Account ownership type
account_paid_date	string or null <date> Account paid date
account_status	string Current account status
account_type	string Type of account
bureau_tradeline_id	string Bureau tradeline ID
charge_off_date	string or null <date> Charge-off date
	object (Client) Client object
client_key	string Client unique key
close_date	string or null <date> Date account was closed
collection_date	string or null <date> Collection date
	Array of objects (CorrespondenceResponse) List of related correspondence
credit_balance	string or null Credit balance
credit_limit	string or null Credit limit
credit_loan_type	string or null Credit loan type
credit_report_id	integer Credit report ID
current_rateing_code	string or null Current rating code
current_rating_type	string or null Current rating type
high_balance_amount	string or null High balance amount
high_credit_amount	string or null High credit amount
highest_adverse_rating_code	string or null Highest adverse rating code
highest_adverse_rating_type	string or null Highest adverse rating type
internal_client_key	string Internal client key
is_charge_off	boolean Whether item is charged off
is_closed	boolean Whether account is closed
is_collection	boolean Whether item is in collection
is_disputed	boolean Whether item is disputed
is_mortgage	boolean Whether item is a mortgage
is_negative	boolean Whether item is negative
is_revolving	boolean Whether item is revolving credit
is_secure_loan	boolean Whether item is a secure loan
last_activity_date	string or null <date> Last activity date
last_payment_date	string or null <date> Last payment date
late_count_30_days	integer or null Count of 30-day late payments
late_count_60_days	integer or null Count of 60-day late payments
late_count_90_days	integer or null Count of 90-day late payments
loan_type	string or null Type of loan
	object (Negative Item Metadata Resource) Metadata information for a negative credit item including status and dispute flags
modified_date	string <datetime> Last modified date
monthly_payment	string or null Monthly payment amount
months_viewed	integer or null Months viewed
most_recent_adverse_rating_code	string or null Most recent adverse rating code
most_recent_adverse_rating_date	string or null <date> Most recent adverse rating date
most_recent_adverse_rating_type	string or null Most recent adverse rating type
opened_date	string <date> Date account was opened
original_balance_amount	string or null Original balance amount
past_due_amount	string or null Past due amount
report_id	string Report identifier
reported_date	string <date> Date last reported
terms_desc	string or null Terms description
terms_month	integer or null Terms in months
unpaid_balance_amount	string or null Unpaid balance amount
vendor_tradeline_id	string Vendor tradeline ID

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

200
401
403
404
500

Content type

application/json

{"data": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
}
}

Debug

Debug endpoints for testing workflow components

Execute workflow step in debug mode

Execute a workflow step with debug information and safety measures. Only available in non-production environments.

Authorizations:

x-api-key

path Parameters

workflowStep required	integer <int64> Workflow Step ID to execute
client required	integer <int64> Client ID to use for workflow step execution

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

data

object

Response Schema: application/json

message

string

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

200
403
404
422
500

Content type

application/json

{"data": { }
}

ClickHouseEvent

Searching and viewing events in ClickHouse for further interaction with them.

Get clickhouse event list

Filtering and searching ClickHouse events.

Authorizations:

bearerAuthx-api-key

query Parameters

event	string Search query by event name
rudderId	string Filter by rudder ID
sort_by	string Enum: "event" "timestamp" "rudderId" Field to sort by (event, timestamp, rudderId)
sort_direction	string Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Page number (e.g., 1)
per_page	integer Items per page (e.g., 10)

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (ClickHouseEventResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

200
401
403
422
500

Content type

application/json

{"data": [{"context": [{"library": {"name": "rudder-analytics-php",
"version": "2.1.0"
}
}
],
"event": "User Login",
"properties": [{"ip_address": "xxx.xxx.xxx.xxx",
"user_id": 123
}
],
"rudderId": "9eb8bcf1-eb3a-48c7-8948-53a39a8b80eb",
"timestamp": "2025-08-06T14:03:51.000Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get a ClickHouseEvent by name

Retrieving full information of a clickhouse event by its event name.

Authorizations:

bearerAuthx-api-key

path Parameters

eventName

required

string

ClickHouseEvent name identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects ClickHouseEvent context data
event	string ClickHouseEvent event name
	Array of objects ClickHouseEvent properties data
rudderId	string <uuid> ClickHouseEvent rudder Id unique identifier
timestamp	string <date-time> ClickHouseEvent timestamp

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

200
401
403
404
500

Content type

application/json

{"context": [{"library": {"name": "rudder-analytics-php",
"version": "2.1.0"
}
}
],
"event": "User Login",
"properties": [{"ip_address": "xxx.xxx.xxx.xxx",
"user_id": 123
}
],
"rudderId": "9eb8bcf1-eb3a-48c7-8948-53a39a8b80eb",
"timestamp": "2025-08-06T14:03:51.000Z"
}

Furnisher

Operations for managing furnishers. Furnishers are companies that provide consumer credit history information to credit bureaus. These endpoints allow users to create, retrieve, update, and delete furnisher records in the system.

Get a list of furnishers

Retrieve a paginated list of furnishers with search, filtering, and sorting capabilities

Authorizations:

bearerAuthx-api-key

query Parameters

name	string Name of Furnisher
type	string Enum: "Collection_Agency" "Government_Office" "Original_Creditor" "Public_Record" type of the furnisher
per_page	integer Items per page (e.g., 10)
page	integer Page number
sort_by	string Sort by
sort_direction	string Enum: "asc" "desc" Sort direction

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (FurnisherResponse)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"created_at": "2019-08-24T14:15:22Z",
"fax_number": "string",
"id": 0,
"name": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create a Furnisher

Create a new Furnisher with the provided data

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data required to create a new furnisher record including name, address,contact information, and reporting details to credit bureaus

fax_number	string Fax number of the Furnisher
name	string Name of the Furnisher
type	string Enum: "Collection_Agency" "Government_Office" "Original_Creditor" "Public_Record" Type of the Furnisher

Responses

Response Schema: application/json

object (FurnisherResponse)

created_at	string <date-time> Created at
fax_number	string Furnisher fax number
id	integer ID
name	string Furnisher name
type	string Furnisher type
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"fax_number": "string",
"name": "string",
"type": "Collection_Agency"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"fax_number": "string",
"id": 0,
"name": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete a Furnisher

Delete Furnisher by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Furnisher unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Get a Furnisher

Get a Furnisher by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Furnisher unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (GoalResponse)

created_at	string <date-time> Created at
icon	string Goal icon
id	integer ID
name	string Goal name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"icon": "string",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update a Furnisher

Update an existing furnishers details including name, address, contact information, and reporting settings

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Furnisher unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to update an existing Furnisher

fax_number	string Fax number of the Furnisher
name	string shortcode without brackets
type	string Enum: "Collection_Agency" "Government_Office" "Original_Creditor" "Public_Record" Type of the Furnisher

Responses

Response Schema: application/json

object (FurnisherResponse)

created_at	string <date-time> Created at
fax_number	string Furnisher fax number
id	integer ID
name	string Furnisher name
type	string Furnisher type
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"fax_number": "string",
"name": "string",
"type": "Collection_Agency"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"fax_number": "string",
"id": 0,
"name": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Goal

API endpoints to manage existing client goals.

Get all Goals

Get all existing goals list with their full information.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (GoalResponse)

created_at	string <date-time> Created at
icon	string Goal icon
id	integer ID
name	string Goal name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"icon": "string",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Create Goal

Create a new goal with name and icon (which can be used as a badge at frontend).

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

icon	string Goal icon
name	string Goal name

Responses

Response Schema: application/json

created_at	string <date-time> Created at
icon	string Goal icon
id	integer ID
name	string Goal name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"icon": "string",
"name": "string"
}

Response samples

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"icon": "string",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Goal

Delete goal by unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Goal unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Get Goal

Retrieving full information of a goal by its unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Goal unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

created_at	string <date-time> Created at
icon	string Goal icon
id	integer ID
name	string Goal name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"icon": "string",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Goal

Update an existing goal by id with name and icon (which can be used as a badge at frontend).

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Goal unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

name required	string <= 255 characters Goal name
icon required	string <= 255 characters Goal icon name

Responses

Response Schema: application/json

created_at	string <date-time> Created at
icon	string Goal icon
id	integer ID
name	string Goal name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"icon": "string",
"name": "string"
}

Response samples

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"icon": "string",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

Import

Manual import Clients data by CSV file.

Get list of imports

Retrieving all import files

Authorizations:

bearerAuthx-api-key

query Parameters

search	string Search query (e.g. type, created_by, status, created_at).
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (ImportResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"created_at": "2019-08-24T14:15:22Z",
"created_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"error_log": "string",
"id": 0,
"processed_records": 0,
"status": "string",
"total_records": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Link an attachment as a Import

Link the uploaded attachment as a Import of Clients Data. (Available types: add, update, delete)

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

type required	string Enum: "add" "update" "delete" Filtering documents by type.
attachment_id required	integer Attachment unique identifier

Responses

Response Schema: application/json

object (ImportResource)

created_at	string <date-time> Creation timestamp
	object (User) User object
error_log	string Import Error log
id	integer Import ID
processed_records	integer Import processed records
status	string Import status
total_records	integer Import total records
type	string Import type
updated_at	string <date-time> Update timestamp

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"attachment_id": 0,
"type": "add"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"created_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"error_log": "string",
"id": 0,
"processed_records": 0,
"status": "string",
"total_records": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Export an example CSV

Generate and download an example CSV with predefined data.

Authorizations:

x-api-key

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

401
403
419
422
500

Content type

application/json

{"message": "Unauthenticated."
}

Note

Operations for managing internal client notes. These endpoints allow staff to create, retrieve, update, and delete notes associated with specific clients. Notes are used for internal communication and record-keeping purposes and are not visible to clients.

Get all Notes

Retrieve a paginated list of internal client notes with filtering and sorting options

Authorizations:

bearerAuthx-api-key

query Parameters

search	string Search query (e.g. value of: created_at, user_id, note_text etc.)
client_id	string Search query (e.g. value of: client_id.)
sort_by	string Sort column field (e.g., id, note_text, user_id, created_at)
sort_direction	string Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Page number (e.g., 1)
per_page	integer Items per page (e.g., 10)

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (NoteResponse)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"client_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"note_text": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
}
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create a Note

Create a new internal Note associated with a specific client

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to create a new note associated with a specific client

client_id	integer Client ID
note_text	string Note content

Responses

Response Schema: application/json

object (NoteResponse)

client_id	integer ID
created_at	string <date-time> Created at
id	integer ID
note_text	string Note text
updated_at	string <date-time> Updated at
	(User (object or null)) Note author details

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"client_id": 0,
"note_text": "string"
}

Response samples

Content type

application/json

{"data": {"client_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"note_text": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
}
}
}

Delete Note

Delete note by specified unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Note unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Get a Note

Get a specific internal note by ID with associated user information

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Note id

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (NoteResponse)

client_id	integer ID
created_at	string <date-time> Created at
id	integer ID
note_text	string Note text
updated_at	string <date-time> Updated at
	(User (object or null)) Note author details

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"client_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"note_text": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
}
}
}

Update a Note

Update the content of an existing internal note associated with a specific client

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Note id

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to update an existing note

client_id	integer Client ID
note_text	string Note content

Responses

Response Schema: application/json

object (NoteResponse)

client_id	integer ID
created_at	string <date-time> Created at
id	integer ID
note_text	string Note text
updated_at	string <date-time> Updated at
	(User (object or null)) Note author details

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"client_id": 0,
"note_text": "string"
}

Response samples

Content type

application/json

{"data": {"client_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"note_text": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
}
}
}

Products

API endpoints to view all existing Products.

Get all Products

Get all existing Products list with their full information.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (ProductResponse)

created_at	string <date-time> Created at
id	integer ID
name	string Products name
product_code	string Products code
product_type	string Products Type
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"product_code": "string",
"product_type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Role

API endpoints related to retrieving the list of roles and information about them.

Get all Roles

Endpoint for retrieving the list of roles and information about them.

Authorizations:

bearerAuthx-api-key

query Parameters

name	string Filtering by role name.
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (UserRole)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get a role

Retrieving information about a ole by its unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Role unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (UserRole)

UserRole object

id	string Unique identifier.
name	string Name of the role
	Array of objects (RolePermission) Roles permissions

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
}

QueryBuilder

The query builder is designed for dynamically constructing client retrieval queries. It takes into account client relationships and attributes, allowing for complex queries and providing a list of fields and values available for the specified condition.

Get Query Builder fields

Retrieving available fields for filtering based on the specified complex conditions. Supports optional model parameter to specify which model to use (client or negative_item). Defaults to client model if not specified.

Authorizations:

bearerAuthx-api-key

path Parameters

modelName

string

Enum: "client" "negative_item"

Optional model name to specify which Query Builder service to use. Available values: client, negative_item. Defaults to client if not provided.

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

combinator	string Enum: "AND" "OR" Condition combinator.
count_repeat	integer or null Number of condition repetitions.
not	boolean or null Default: 0 Flag for negating the condition — if the condition evaluates to true and you set this parameter to true, the expected result will be false.
relation	string or null Relation name.
rules	Array of objects

Responses

Response Schema: application/json

Array of objects (GraphResourceCollection)

Array

object

type	string Field type

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

{"data": [{"relationName": {"type": "string"
}
}
]
}

Get available Query Builder models

Retrieving the list of available models for Query Builder operations.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

data	Array of strings List of available models for Query Builder operations

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

200
401
403
419
500

Content type

application/json

{"data": ["client",
"negative_item"
]
}

Get Query Builder values

Retrieving the list of available values for the specified condition and given field name. Supports optional model parameter to specify which model to use (client or negative_item). Defaults to client model if not specified.

Authorizations:

bearerAuthx-api-key

path Parameters

modelName

string

Enum: "client" "negative_item"

Optional model name to specify which Query Builder service to use. Available values: client, negative_item. Defaults to client if not provided.

query Parameters

per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

combinator	string Enum: "AND" "OR" Condition combinator.
	object (SegmentRuleGroup) A group of rules for filtering clients in a segment
field_name	string <= 255 characters

Responses

Response Schema: application/json

data	Array of strings List of all possible values for the query fields
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"combinator": "AND",
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"field_name": "string"
}

Response samples

Content type

application/json

{"data": ["value1"
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Segment

API Endpoints for managing client segments

Get Attribute Types List

Retrieving the full list of supported types and their operators for segment conditions.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

Array

	Array of strings or integers Available Values for the type
typeName	string Type name

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

[{"availableValues": ["string"
],
"typeName": "string"
}
]

Get all Segments

Filtering Segments by specified parameters and pagination.

Authorizations:

bearerAuthx-api-key

query Parameters

is_archive required	integer Enum: 1 0 Filter by archive status
search	string Search by name or description
is_active	integer Enum: 1 0 Filter by active status
client_id	integer Client unique identifier
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
type	string Enum: "client" "negative_item" Segment type.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

Array

clients_count	integer or null
	object (SegmentRuleGroup) A group of rules for filtering clients in a segment
created_at	string <date-time>
description	string or null
id	integer <int64>
is_active	boolean
is_archive	boolean
name	string
negative_items_count	integer or null
type	string
updated_at	string <date-time>
usage_count	integer or null The number of unique workflows that use this segment in the trigger condition.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

[{"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
}
]

Create Segment.

Create a new Segment record.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

combinator	string Enum: "AND" "OR" Condition combinator.
	object (SegmentRuleGroup) A group of rules for filtering clients in a segment
description	string or null Segment description
is_active	boolean Default: 1 Segment is active?
is_archive	boolean Default: 0 Segment is archive?
name	string <= 255 characters Segment name
type	string Default: "client" Enum: "client" "negative_item" Segment type

Responses

Response Schema: application/json

clients_count	integer or null
	object (SegmentRuleGroup) A group of rules for filtering clients in a segment
created_at	string <date-time>
description	string or null
id	integer <int64>
is_active	boolean
is_archive	boolean
name	string
negative_items_count	integer or null
type	string
updated_at	string <date-time>
usage_count	integer or null The number of unique workflows that use this segment in the trigger condition.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"combinator": "AND",
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"description": "string",
"is_active": 1,
"is_archive": 0,
"name": "string",
"type": "client"
}

Response samples

Content type

application/json

{"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
}

Refresh Segment Relations.

Endpoint that immediately updates the segment's relationship with clients, i.e., re-selects clients based on the conditions and saves the results.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Segment unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

clients_count	integer or null
	object (SegmentRuleGroup) A group of rules for filtering clients in a segment
created_at	string <date-time>
description	string or null
id	integer <int64>
is_active	boolean
is_archive	boolean
name	string
negative_items_count	integer or null
type	string
updated_at	string <date-time>
usage_count	integer or null The number of unique workflows that use this segment in the trigger condition.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
}

Delete Segment.

Delete an segment by its unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Segment unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

Response samples

Content type

application/json

{"message": "Unauthenticated."
}

Get Segment.

Retrieving full information of an segment by its unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Segment unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

clients_count	integer or null
	object (SegmentRuleGroup) A group of rules for filtering clients in a segment
created_at	string <date-time>
description	string or null
id	integer <int64>
is_active	boolean
is_archive	boolean
name	string
negative_items_count	integer or null
type	string
updated_at	string <date-time>
usage_count	integer or null The number of unique workflows that use this segment in the trigger condition.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
}

Update Segment.

Update an existing Segment record.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Segment unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

combinator	string Enum: "AND" "OR" Condition combinator.
	(SegmentRuleGroup (object or null))
description	string or null
is_active	boolean or null Default: 1
is_archive	boolean or null Default: 0
name	string <= 255 characters
type	string or null Enum: "client" "negative_item"

Responses

Response Schema: application/json

clients_count	integer or null
	object (SegmentRuleGroup) A group of rules for filtering clients in a segment
created_at	string <date-time>
description	string or null
id	integer <int64>
is_active	boolean
is_archive	boolean
name	string
negative_items_count	integer or null
type	string
updated_at	string <date-time>
usage_count	integer or null The number of unique workflows that use this segment in the trigger condition.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"combinator": "AND",
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"description": "string",
"is_active": 1,
"is_archive": 0,
"name": "string",
"type": "client"
}

Response samples

Content type

application/json

{"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
}

Export Segment Clients.

Exporting the list of clients from the segment. In CSV format.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Segment unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "Unauthenticated."
}

Claim Code

Endpoints for managing claim codes, which are standardized codes used to categorize and track the reasons for disputing negative credit items. These codes help streamline the credit repair process by providing a consistent and organized way to identify and address disputes.

Get all Claim Codes

Retrieve a list of claim codes used for categorizing credit dispute reasons

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (ClaimCodeResponse)

created_at	string <date-time> Creation timestamp
eq_code	string or null Equifax claim code
ex_code	string or null Experian claim code
id	integer Claim Code ID
is_active	boolean Indicates if the claim code is active
tcp_name	string Claim code TCP name
tu_code	string or null Transunion claim code
updated_at	string <date-time> Update timestamp

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"eq_code": "string",
"ex_code": "string",
"id": 0,
"is_active": true,
"tcp_name": "string",
"tu_code": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Create a Claim Code

Create a new claim code to categorize a specific type of credit dispute reason

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to create a new claim code

eq_code	string Equifax claim code (prefix part)
ex_code	string Experian claim code (prefix part)
is_active	boolean Status of claim code
tcp_name	string Claim code TCP name (human readable)
tu_code	string Transunion claim code (prefix part)

Responses

Response Schema: application/json

object (ClaimCodeResponse)

created_at	string <date-time> Creation timestamp
eq_code	string or null Equifax claim code
ex_code	string or null Experian claim code
id	integer Claim Code ID
is_active	boolean Indicates if the claim code is active
tcp_name	string Claim code TCP name
tu_code	string or null Transunion claim code
updated_at	string <date-time> Update timestamp

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"eq_code": "string",
"ex_code": "string",
"is_active": true,
"tcp_name": "string",
"tu_code": "string"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"eq_code": "string",
"ex_code": "string",
"id": 0,
"is_active": true,
"tcp_name": "string",
"tu_code": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete a Claim Code

Delete claim code by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Claim code unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Update a Claim Code

Updates an existing claim code by its unique identifier, allowing changes to its code identifier, description, and any additional details that define its usage in credit dispute categorization.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Claim code id

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

eq_code	string <= 255 characters Equifax claim code (prefix part)
ex_code	string <= 255 characters Experian claim code (prefix part)
is_active	boolean Status of claim code
tcp_name	string <= 255 characters TCP name (human readable part)
tu_code	string <= 255 characters Transunion claim code (prefix part)

Responses

Response Schema: application/json

object (ClaimCodeResponse)

created_at	string <date-time> Creation timestamp
eq_code	string or null Equifax claim code
ex_code	string or null Experian claim code
id	integer Claim Code ID
is_active	boolean Indicates if the claim code is active
tcp_name	string Claim code TCP name
tu_code	string or null Transunion claim code
updated_at	string <date-time> Update timestamp

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"eq_code": "string",
"ex_code": "string",
"is_active": true,
"tcp_name": "string",
"tu_code": "string"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"eq_code": "string",
"ex_code": "string",
"id": 0,
"is_active": true,
"tcp_name": "string",
"tu_code": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Creditor Type

Endpoints for managing creditor types and subtypes.

Get Creditor Type List

Returns a list of creditor types and subtypes.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (CreditorTypeResponse)

created_at	string <date-time> Creation timestamp
id	integer Creditor Type ID
subtype	string Creditor subtype
type	string Main creditor type
updated_at	string <date-time> Update timestamp

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"subtype": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

EventDefinition

API for event definition management, an entity that serves as an identifier for a specific event.

Get list of Event Definitions

Filtering and retrieving the list of available event definitions with pagination and sorting.

Authorizations:

bearerAuthx-api-key

query Parameters

search	string Search by name or description
source	string Filter by source
status	string Enum: "draft" "active" Filter by status
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (EventDefinitionResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
}
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"stepExecutions": [null
],
"step_order": 0,
"template": {"category": null,
"contents": [ ],
"created_at": null,
"deleted_at": null,
"id": null,
"is_dispute": null,
"name": null,
"preview_content": null,
"type": null,
"updated_at": null
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
},
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
},
"workflowInstances": [{"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
}
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create Event Definition

Create a new Event Definition object.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

name required	string Name
description required	string Description
source required	string Source
schema required	Array of strings List of attribute keys like "property", "properties.property1"
status	string Enum: "draft" "active" Status

Responses

Response Schema: application/json

object (EventDefinitionResource)

Schema of the EventDefinition structure.

created_at	string <date-time> Date and time of creation.
description	string or null EventDefinition description
	Array of objects or null (EventResource) List of events that have occurred and are related to this event definition, essentially an event log.
id	integer EventDefinition unique identifier
name	string EventDefinition name
	object Schema
source	string EventDefinition source
status	string Enum: "draft" "active" Status
	Array of objects or null (TriggerEventConditionResource) List of all trigger event conditions that are executed each time the event is triggered.
updated_at	string <date-time> Date and time of modification.

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"schema": ["context.payload.client_id"
],
"source": "string",
"status": "draft"
}

Response samples

201

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"stepExecutions": [null
],
"step_order": 0,
"template": {"category": null,
"contents": [ ],
"created_at": null,
"deleted_at": null,
"id": null,
"is_dispute": null,
"name": null,
"preview_content": null,
"type": null,
"updated_at": null
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": null,
"completion_status": null,
"createdBy": null,
"created_at": null,
"description": null,
"exit_on_trigger_mismatch": null,
"id": null,
"is_active": null,
"is_archive": null,
"is_version": null,
"lastModifiedBy": null,
"max_duration": null,
"name": null,
"steps": [ ],
"trigger": null,
"type": null,
"updated_at": null,
"workflowInstances": [ ],
"workflowNotes": [ ]
}
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"stepExecutions": [null
],
"step_order": 0,
"template": {"category": null,
"contents": [ ],
"created_at": null,
"deleted_at": null,
"id": null,
"is_dispute": null,
"name": null,
"preview_content": null,
"type": null,
"updated_at": null
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
},
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
}
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete Event Definition

Delete EventDefinition by unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

EventDefinition unique identifier

header Parameters

x-api-key

required

string

Responses

Get an Event Definition

Retrieving detailed information about an event definition by its unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

EventDefinition unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (EventDefinitionResource)

Schema of the EventDefinition structure.

created_at	string <date-time> Date and time of creation.
description	string or null EventDefinition description
	Array of objects or null (EventResource) List of events that have occurred and are related to this event definition, essentially an event log.
id	integer EventDefinition unique identifier
name	string EventDefinition name
	object Schema
source	string EventDefinition source
status	string Enum: "draft" "active" Status
	Array of objects or null (TriggerEventConditionResource) List of all trigger event conditions that are executed each time the event is triggered.
updated_at	string <date-time> Date and time of modification.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"stepExecutions": [null
],
"step_order": 0,
"template": {"category": null,
"contents": [ ],
"created_at": null,
"deleted_at": null,
"id": null,
"is_dispute": null,
"name": null,
"preview_content": null,
"type": null,
"updated_at": null
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": null,
"completion_status": null,
"createdBy": null,
"created_at": null,
"description": null,
"exit_on_trigger_mismatch": null,
"id": null,
"is_active": null,
"is_archive": null,
"is_version": null,
"lastModifiedBy": null,
"max_duration": null,
"name": null,
"steps": [ ],
"trigger": null,
"type": null,
"updated_at": null,
"workflowInstances": [ ],
"workflowNotes": [ ]
}
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"stepExecutions": [null
],
"step_order": 0,
"template": {"category": null,
"contents": [ ],
"created_at": null,
"deleted_at": null,
"id": null,
"is_dispute": null,
"name": null,
"preview_content": null,
"type": null,
"updated_at": null
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
},
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
}
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update Event Definition

Update Event Definition object.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

EventDefinition ID

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

description	string or null Description
name	string or null Name
schema	Array of context.payload.client_id or null List of attribute keys like "property", "properties.property1"
source	string or null Source
status	string or null Enum: "draft" "active" Status

Responses

Response Schema: application/json

object (EventDefinitionResource)

Schema of the EventDefinition structure.

created_at	string <date-time> Date and time of creation.
description	string or null EventDefinition description
	Array of objects or null (EventResource) List of events that have occurred and are related to this event definition, essentially an event log.
id	integer EventDefinition unique identifier
name	string EventDefinition name
	object Schema
source	string EventDefinition source
status	string Enum: "draft" "active" Status
	Array of objects or null (TriggerEventConditionResource) List of all trigger event conditions that are executed each time the event is triggered.
updated_at	string <date-time> Date and time of modification.

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"schema": [null
],
"source": "string",
"status": "draft"
}

Response samples

200

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"stepExecutions": [null
],
"step_order": 0,
"template": {"category": null,
"contents": [ ],
"created_at": null,
"deleted_at": null,
"id": null,
"is_dispute": null,
"name": null,
"preview_content": null,
"type": null,
"updated_at": null
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": null,
"completion_status": null,
"createdBy": null,
"created_at": null,
"description": null,
"exit_on_trigger_mismatch": null,
"id": null,
"is_active": null,
"is_archive": null,
"is_version": null,
"lastModifiedBy": null,
"max_duration": null,
"name": null,
"steps": [ ],
"trigger": null,
"type": null,
"updated_at": null,
"workflowInstances": [ ],
"workflowNotes": [ ]
}
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"stepExecutions": [null
],
"step_order": 0,
"template": {"category": null,
"contents": [ ],
"created_at": null,
"deleted_at": null,
"id": null,
"is_dispute": null,
"name": null,
"preview_content": null,
"type": null,
"updated_at": null
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
},
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
}
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
}
}

Instruction

Operations for managing dispute resolution instructions. These endpoints allow users to create, retrieve, update, and delete instruction templates used to resolve disputes related to negative credit items. Instructions can be filtered by parent or child type of items and are associated with specific claim codes and dispute conditions.

Get a list of instructions

Returns a list of instructions that can be used to resolve disputes related to negative credit items. The list can be filtered by parent or child type of items and sorted by various criteria.

Authorizations:

bearerAuthx-api-key

query Parameters

name	string Name
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_by	string Sort column field (e.g., order, id)
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (InstructionResponse)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"claim_code": {"created_at": "2019-08-24T14:15:22Z",
"eq_code": "string",
"ex_code": "string",
"id": 0,
"is_active": true,
"tcp_name": "string",
"tu_code": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"creditor_types": [{"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"subtype": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"id": 0,
"name": "string",
"order": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create an Instruction

Create a new dispute resolution instruction with text, claim code, and item type conditions

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to create a new instruction

claim_code_id	integer Claim code unique identifier
creditor_types	Array of integers Array of creditor type IDs to be attached
name	string Instruction name

Responses

Response Schema: application/json

object (InstructionResponse)

	object (ClaimCodeResponse)
created_at	string <date-time> Creation timestamp
	Array of objects (CreditorTypeResponse) List of associated creditor types
id	integer Instruction ID
name	string Instruction name
order	integer Instruction Order in grid
updated_at	string <date-time> Update timestamp

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"claim_code_id": 0,
"creditor_types": [0
],
"name": "string"
}

Response samples

Content type

application/json

{"data": {"claim_code": {"created_at": "2019-08-24T14:15:22Z",
"eq_code": "string",
"ex_code": "string",
"id": 0,
"is_active": true,
"tcp_name": "string",
"tu_code": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"creditor_types": [{"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"subtype": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"id": 0,
"name": "string",
"order": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete an Instruction

Delete an instruction by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

instruction

required

integer

Instruction unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Get an instruction

Get a specific dispute resolution instruction by unique identifier with associated claim code and conditions

Authorizations:

bearerAuthx-api-key

path Parameters

instruction

required

integer

Instruction unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (InstructionResponse)

	object (ClaimCodeResponse)
created_at	string <date-time> Creation timestamp
	Array of objects (CreditorTypeResponse) List of associated creditor types
id	integer Instruction ID
name	string Instruction name
order	integer Instruction Order in grid
updated_at	string <date-time> Update timestamp

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"claim_code": {"created_at": "2019-08-24T14:15:22Z",
"eq_code": "string",
"ex_code": "string",
"id": 0,
"is_active": true,
"tcp_name": "string",
"tu_code": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"creditor_types": [{"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"subtype": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"id": 0,
"name": "string",
"order": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update an Instruction

Update an existing dispute resolution instruction including text, claim code, and conditions

Authorizations:

bearerAuthx-api-key

path Parameters

instruction

required

integer

Instruction unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to update an instruction

claim_code_id	integer Claim code unique identifier
creditor_types	Array of integers Array of creditor type IDs to be attached
name	string Instruction name

Responses

Response Schema: application/json

object (InstructionResponse)

	object (ClaimCodeResponse)
created_at	string <date-time> Creation timestamp
	Array of objects (CreditorTypeResponse) List of associated creditor types
id	integer Instruction ID
name	string Instruction name
order	integer Instruction Order in grid
updated_at	string <date-time> Update timestamp

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"claim_code_id": 0,
"creditor_types": [0
],
"name": "string"
}

Response samples

Content type

application/json

{"data": {"claim_code": {"created_at": "2019-08-24T14:15:22Z",
"eq_code": "string",
"ex_code": "string",
"id": 0,
"is_active": true,
"tcp_name": "string",
"tu_code": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"creditor_types": [{"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"subtype": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"id": 0,
"name": "string",
"order": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
}

Move instruction from one position to another at grid

Authorizations:

bearerAuthx-api-key

path Parameters

instruction

required

integer

Instruction ID

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Movement parameters

order_from	integer Position of the instruction before dragging
order_to	integer Position of the instruction after dragging

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"order_from": 0,
"order_to": 0
}

Response samples

Content type

application/json

{"message": "string"
}

Dropdown Options

Operations for managing configuration options for negative credit items. These endpoints allow administrators to retrieve, create, update, and delete dropdown values for item types,statuses, responsibility designations, and attestation statuses used throughout the credit repair process.

Delete a Dropdown Option

Delete a dropdown option by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Item Dropdown unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

401
403
419
422
500

Content type

application/json

{"message": "Unauthenticated."
}

Update a Dropdown Option

Update an existing Dropdown Option for a negative credit item

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

dropdown item id

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

value

required

string <= 255 characters

Item Dropdown value

Responses

Response Schema: application/json

object (ItemDropdownResource)

created_at	string <date-time> Creation timestamp
	object User who created the Item Dropdown
id	integer Dropdown ID
type	string Type of dropdown
updated_at	string <date-time> Update timestamp
value	string Dropdowns column value

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"created_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"id": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"value": "string"
}
}

Get a list of Dropdown Options

Retrieve a list of dropdown options for a specific type of negative credit item

Authorizations:

bearerAuthx-api-key

path Parameters

type

required

string

Type of drop down

query Parameters

search	string Search query by value(e.g. value of main column at each table(Responsibility, Type etc.)
id	string Search query by unique identifier
created_at	datetime Search query by date create
author	string Search query by author (first_name,last_name,email)
sort_by	string Sort column field (e.g., id, value, created_at)
sort_direction	string Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Page number (e.g., 1)
per_page	integer Items per page (e.g., 10)

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (ItemDropdownResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response samples

200

Content type

application/json

{"data": [{"created_at": "2019-08-24T14:15:22Z",
"created_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"id": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"value": "string"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create a new Dropdown Option

Create a new Dropdown Option for a specific type of negative credit item

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

type required	string <= 255 characters Item Dropdown type
value required	string <= 255 characters Item Dropdown value

Responses

Response Schema: application/json

object (ItemDropdownResource)

created_at	string <date-time> Creation timestamp
	object User who created the Item Dropdown
id	integer Dropdown ID
type	string Type of dropdown
updated_at	string <date-time> Update timestamp
value	string Dropdowns column value

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"type": "string",
"value": "string"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"created_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"id": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"value": "string"
}
}

Snippet

Operations for managing snippets. Snippets can be created, updated and cloned. They support shortcode parsing for dynamic content using Variables.

Get a list of Snippets

Retrieve a paginated list of reusable content Snippets with filtering and sorting options

Authorizations:

bearerAuthx-api-key

query Parameters

id	integer Unique identifier of Snippet
name	string Name of Snippet
created_at	string Example: created_at=2025-01-01 Created at (YYYY-MM-DD)
state_code	string Example: state_code=NY Related State code (two letter code)
per_page	integer Items per page (e.g., 10)
page	integer Page number
sort_by	string Sort by
sort_direction	string Enum: "asc" "desc" Sort direction

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (SnippetResponse)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_state_related": true,
"name": "string",
"state_code": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create a new Snippet

Creates a new content snippet that can be used to build templates and communications. The snippet can include text, variables, and other metadata that define its purpose and usage.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to create a new Snippet

content	string Snippet content
is_state_related	boolean Is state related to snippet
name	string shortcode without brackets
state_code	string US State Code

Responses

Response Schema: application/json

object (SnippetResponse)

content	string Snippet content
created_at	string <date-time> Created at
id	integer ID
is_state_related	boolean Is state related to snippet
name	string Snippet name
state_code	string US State Code
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"content": "string",
"is_state_related": true,
"name": "string",
"state_code": "NY"
}

Response samples

Content type

application/json

{"data": {"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_state_related": true,
"name": "string",
"state_code": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete Snippet

Delete Snippet by unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Snippet unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Get a Snippet preview

Get a Snippet preview by unique identifier with parsed data of Variables (shortcodes)

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Snippet unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (SnippetResponse)

content	string Snippet content
created_at	string <date-time> Created at
id	integer ID
is_state_related	boolean Is state related to snippet
name	string Snippet name
state_code	string US State Code
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_state_related": true,
"name": "string",
"state_code": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update a Snippet

Updates an existing content Snippet by its ID, allowing changes to its text, name, category, and other metadata. This endpoint is useful for modifying a Snippet that is already in use.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Snippet unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to update an existing Snippet

content	string Snippet content
is_state_related	boolean Is state related to Snippet
name	string shortcode without brackets
state_code	string US State Code

Responses

Response Schema: application/json

object (SnippetResponse)

content	string Snippet content
created_at	string <date-time> Created at
id	integer ID
is_state_related	boolean Is state related to snippet
name	string Snippet name
state_code	string US State Code
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"content": "string",
"is_state_related": true,
"name": "string",
"state_code": "NY"
}

Response samples

Content type

application/json

{"data": {"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_state_related": true,
"name": "string",
"state_code": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Clone a Snippet

Clone a Snippet by ID with automatic name generation. Creates a copy of an existing Snippet with a new automatically generated name. The naming follows the pattern "Copy {original_name}" with numeric suffixes (1, 2, etc.)added if needed to ensure uniqueness.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Snippet ID to clone

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (SnippetResponse)

content	string Snippet content
created_at	string <date-time> Created at
id	integer ID
is_state_related	boolean Is state related to snippet
name	string Snippet name
state_code	string US State Code
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_state_related": true,
"name": "string",
"state_code": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Template Category

Operations for managing Template Categories used to organize communication templates. These endpoints allow creating, retrieving, updating, and deleting categories that help classify templates based on their purpose and usage context (e.g., Collection Agency, Government Office, Original Creditor, Bureau, Clients). Template categories are essential for organizing the various templates used in workflow steps and customer portal.

Get a list of Template Categories

Retrieve a paginated list of Template Categories with filtering and sorting options

Authorizations:

bearerAuthx-api-key

query Parameters

name	string Template Category name
per_page	integer Per page
page	integer Page number
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (TemplateCategoryResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create Template Category

Create a new Template Category for organizing communication templates

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to create a new Template Category

name	string Template Category name

Responses

Response Schema: application/json

object (TemplateCategoryResource)

created_at	string <date-time> Created at
id	integer ID
name	string Template category name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete Template Category

Delete a template category by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Template Category unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Get Template Category

Get a specific template category by unique identifier with associated templates count

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Template Category unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (TemplateCategoryResource)

created_at	string <date-time> Created at
id	integer ID
name	string Template category name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update Template Category

Update an existing Template Category including its name and description

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Template Category unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

name

required

string <= 255 characters

template category name

Responses

Response Schema: application/json

object (TemplateCategoryResource)

created_at	string <date-time> Created at
id	integer ID
name	string Template category name
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Template

Operations for managing Communication Templates. These endpoints allow creating,retrieving, updating, and deleting templates used for various types of client communications including emails,SMS, and letters. Templates support variables and can be categorized by type and purpose.

Get a list of Communication Templates

Retrieve a paginated list of Communication Templates with filtering and sorting options

Authorizations:

bearerAuthx-api-key

query Parameters

name	string Name of Template
category_name	string Name of Templates category
type	string Type of Template
per_page	integer Items per page (e.g., 10)
page	integer Page number
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (TemplateResponse)
	object (PaginationLinks)
	object (PaginationMeta)

Response samples

200

Content type

application/json

{"data": [{"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create Template

Create a new Template for organizing communication Templates

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to create a new Template

category_id	integer Category id of the template
	Array of objects Array of content blocks. Each block may include section_type only if type=smart
is_dispute	boolean Is dispute template
name	string Name of the template
type	string Enum: "static" "smart" "sms" "reference" Type of the template

Responses

Response Schema: application/json

object (TemplateResponse)

	object (TemplateCategoryResource)
	Array of objects (TemplateContentResource) List of content blocks for this template
created_at	string <date-time> Created at
deleted_at	string <date-time> Deleted at
id	integer ID
is_dispute	boolean Is dispute template
name	string Template name
preview_content	string All contents in one text with parsed variables
type	string Template type
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"category_id": 0,
"contents": [{"content": "string",
"section_type": "opening"
}
],
"is_dispute": false,
"name": "string",
"type": "static"
}

Response samples

Content type

application/json

{"data": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete Template

Delete Template by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Template unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Get a Template preview

Get a Template preview by unique identifier with all shortcodes parsed into actual valuesFor smart templates, all data in brackets "{test1|test2|test3}" will be randomly selected viaa separator "|". If present client_id - all client variables will be replaced.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Template unique identifier

query Parameters

client_id

integer

Client identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (TemplateResponse)

	object (TemplateCategoryResource)
	Array of objects (TemplateContentResource) List of content blocks for this template
created_at	string <date-time> Created at
deleted_at	string <date-time> Deleted at
id	integer ID
is_dispute	boolean Is dispute template
name	string Template name
preview_content	string All contents in one text with parsed variables
type	string Template type
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update a Template

Update an existing communication Template including its content, variables, and metadata

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Template id

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to update an existing Template

category_id	integer Category id of the template
	Array of objects Array of content blocks
is_dispute	boolean Is dispute template
name	string Name of the template
type	string Enum: "static" "smart" "sms" "reference" Type of the template

Responses

Response Schema: application/json

object (TemplateResponse)

	object (TemplateCategoryResource)
	Array of objects (TemplateContentResource) List of content blocks for this template
created_at	string <date-time> Created at
deleted_at	string <date-time> Deleted at
id	integer ID
is_dispute	boolean Is dispute template
name	string Template name
preview_content	string All contents in one text with parsed variables
type	string Template type
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"category_id": 0,
"contents": [{"content": "string",
"id": 0,
"section_type": "opening"
}
],
"is_dispute": false,
"name": "string",
"type": "static"
}

Response samples

Content type

application/json

{"data": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Clone a template

Clone a template by ID with automatic name generation. Creates a copy of an existing template with a new automatically generated name. The naming follows the pattern "Copy {original_name}" with numeric suffixes (1, 2, etc.)added if needed to ensure uniqueness.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Template ID to clone

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (TemplateResponse)

	object (TemplateCategoryResource)
	Array of objects (TemplateContentResource) List of content blocks for this template
created_at	string <date-time> Created at
deleted_at	string <date-time> Deleted at
id	integer ID
is_dispute	boolean Is dispute template
name	string Template name
preview_content	string All contents in one text with parsed variables
type	string Template type
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

User

API endpoints related to User management.

Get Users list

Get a list of Users with filtering options.

Authorizations:

bearerAuthx-api-key

query Parameters

search	string Search for entries by name and email fields.
role	string Role of the user
is_disabled	integer Enum: 0 1 Disable status of the user
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (User)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create User.

Create a new User on the portal. After successful creation, the user will receive an invitation email to set a password.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

first_name required	string First name of the user
last_name required	string Last name of the user
email required	string <email> Email address of the user
role required	string Role of the user
is_disabled	boolean Default: 0 Disable status of the user
password	string Password of the user
password_confirmation	string Confirm Password of the user

Responses

Response Schema: application/json

object (User)

User object

created_at	string <date-time> Date and time of creation.
email	string <email> Email address
first_name	string First name of the user
id	integer Unique identifier.
last_name	string Last name of the user
	Array of objects (UserRole) Roles assigned to the user
updated_at	string <date-time> Date and time of modification.
	object (UserAccessLog) UserAccessLog object

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"first_name": "string",
"is_disabled": 0,
"last_name": "string",
"password": "string",
"password_confirmation": "string",
"role": "string"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
}
}

Delete User.

Delete an user by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

User unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Get User.

Get full information about a User by their unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

User unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (User)

User object

created_at	string <date-time> Date and time of creation.
email	string <email> Email address
first_name	string First name of the user
id	integer Unique identifier.
last_name	string Last name of the user
	Array of objects (UserRole) Roles assigned to the user
updated_at	string <date-time> Date and time of modification.
	object (UserAccessLog) UserAccessLog object

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
}
}

Update User.

Update an existing User on the portal.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

User unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

email	string <email> Email address of the user
first_name	string First name of the user
is_disabled	boolean Disable status of the user
last_name	string Last name of the user
password	string Password of the user
password_confirmation	string Confirm Password of the user
role	string Role of the user

Responses

Response Schema: application/json

object (User)

User object

created_at	string <date-time> Date and time of creation.
email	string <email> Email address
first_name	string First name of the user
id	integer Unique identifier.
last_name	string Last name of the user
	Array of objects (UserRole) Roles assigned to the user
updated_at	string <date-time> Date and time of modification.
	object (UserAccessLog) UserAccessLog object

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"first_name": "string",
"is_disabled": true,
"last_name": "string",
"password": "string",
"password_confirmation": "string",
"role": "string"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
}
}

Variable

Endpoints for managing variables used in system settings or communication templates. Variables are placeholders that can be used to insert dynamic content into templates for letters, SMS, and other communications. These endpoints support various types of variables, including General, Client, Company, Recipients, and Credit Report variables, which can be used to personalize communications and streamline workflow processes.

Get a Variables list.

Retrieves a filtered list of variables based on type and optional category parameters

Authorizations:

bearerAuthx-api-key

query Parameters

type required	string Entity type. Allowed values: general, client, company, recipient, credit_report
category	string Variable category. Allowed values: contract, email_template

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (VariableResponse)

category	string Variable category. Allowed values: contract, email_template
created_at	string <date-time> Created at
id	integer ID
label	string Human readable variable name
name	string shortcode without brackets
type	string Variable type
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"category": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"label": "string",
"name": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Create a Variable.

Creates a new Variable with the provided attributes and returns the created resource

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to create a new Variable

category	string Variable category. Allowed values: contract, email_template
label	string Human readable variable name
name	string shortcode without brackets
type	string Variable type

Responses

Response Schema: application/json

object (VariableResponse)

category	string Variable category. Allowed values: contract, email_template
created_at	string <date-time> Created at
id	integer ID
label	string Human readable variable name
name	string shortcode without brackets
type	string Variable type
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"category": "string",
"label": "string",
"name": "string",
"type": "string"
}

Response samples

Content type

application/json

{"data": {"category": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"label": "string",
"name": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete a Variable.

Delete Variable by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Variable unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Get a Variable.

Retrieves detailed information for a specific Variable by its unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Variable id

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (VariableResponse)

category	string Variable category. Allowed values: contract, email_template
created_at	string <date-time> Created at
id	integer ID
label	string Human readable variable name
name	string shortcode without brackets
type	string Variable type
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"category": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"label": "string",
"name": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update a Variable.

Updates an existing Variable with the specified attributes while preserving its identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Variable id

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to update an existing Variable

category	string Variable category. Allowed values: contract, email_template
label	string Human readable variable name
name	string shortcode without brackets
type	string Variable type

Responses

Response Schema: application/json

object (VariableResponse)

category	string Variable category. Allowed values: contract, email_template
created_at	string <date-time> Created at
id	integer ID
label	string Human readable variable name
name	string shortcode without brackets
type	string Variable type
updated_at	string <date-time> Updated at

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"category": "string",
"label": "string",
"name": "string",
"type": "string"
}

Response samples

Content type

application/json

{"data": {"category": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"label": "string",
"name": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

FaxCallback

API for working with callback request for the fax

Endpoint for handling the fax send callback

Endpoint for callback signal wire service

Authorizations:

x-api-key

path Parameters

id

required

integer <int64>

Callback ID

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

ErrorCode	string or null The error code provides more information on a failed fax.
ErrorMessage	string or null The message explaining the reason for fax failure.
FaxStatus	string or null Enum: "queued" "processing" "sending" "delivered" "receiving" "received" "no-answer" "busy" "failed" "canceled" FaxStatus
MediaSid	string or null The SID that uniquely identifies the fax media.
MediaUrl	string or null The media URL to request to retrieve incoming media.
NumPages	string or null The number of pages received from a successful fax.
OriginalMediaUrl	string or null The original URL passed when a fax is sent.
RemoteStationId	string or null The transmitting subscriber identification (TSID) reported by the fax machine that sent in the fax.

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"ErrorCode": "string",
"ErrorMessage": "string",
"FaxStatus": "queued",
"MediaSid": "string",
"MediaUrl": "string",
"NumPages": "string",
"OriginalMediaUrl": "string",
"RemoteStationId": "string"
}

Response samples

200
404
419
422
500

Content type

application/json

{"message": "string"
}

Client Webhooks

Endpoint for handling Salesforce client data synchronization through webhook, including bulk operations

Upsert of Clients from Salesforce webhook

Mass upsert of Clients from Salesforce webhook data. Requires separate authorization (salesforceWebHookAuth) through its SECRET TOKEN in the header.

Authorizations:

salesforceWebHookAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data from Salesforce for mass upsert of clients

Array of objects (SalesforceClientBulkUpsertItem)

Data array from Salesforce for mass upsert of clients. Requires separate authorization (salesforceWebHookAuth) through its SECRET TOKEN in the header.

Array

salesforce_id required	string Salesforce Client ID
email required	string Email of Client
required	object or null Products associated with client
required	Array of objects (ClientAttribute) Array of client attributes. Required attributes: FirstName, LastName, Status__c, Billing_Status_Code_Hidden__c, TCP_Website_Enrollment__c. Please note that if attributes already existed at the Client and you did not send them in the request, they will be deleted.
id	integer Clients ID
joint_customer_sf_id	string Joint Customer Salesforce ID (for old clients)
mobile_phone	string Mobile Phone of Client
ssn	integer Social Security Number of Client

Responses

Response Schema: application/json

Array of objects

Array

attributes	object
email	string
id	integer Client ID
mobile_phone	string
salesforce_id	string
ssn	integer

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"clients": [{"attributes": [{"label": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"product": {"Charged_Monthly__c": 0.1,
"Initial_Fee__c": 0.1,
"Name": "string",
"ProductCode__c": "string",
"Product_Type__c": "string"
},
"salesforce_id": "string",
"ssn": 0
}
]
}

Response samples

Content type

application/json

{"data": [{"attributes": {"name1": "value1",
"name2": "value2"
},
"email": "string",
"id": 0,
"mobile_phone": "string",
"salesforce_id": "string",
"ssn": "integer"
}
]
}

Workflow/Trigger

The API for creating, editing, and deleting a trigger is designed to configure workflow execution. It includes the conditions under which the workflow will be executed.

Create trigger

Create a new trigger for a workflow

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

workflow_id required	integer Workflow unique identifier
	object Trigger execution conditions

Responses

Response Schema: application/json

object (TriggerResource)

created_at	string <date-time> Created At
id	integer ID
	(TriggerEventConditionResource (object or null)) TriggerEventCondition
type	string Enum: "event" "complex_event" "segment" "time" Type
updated_at	string <date-time> Updated at
	(WorkflowResource (object or null))
	Array of objects or null (WorkflowInstanceResource) WorkflowInstances list

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"triggerEventCondition": {"event_definition_id": "1",
"segment_id": "1"
},
"workflow_id": 1
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
}
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{ }
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": null,
"created_at": null,
"extension": null,
"id": null,
"size": null,
"type": null,
"url": null
}
],
"attributes": [{"name": null,
"value": null
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": null
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
},
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": null,
"created_at": null,
"deleted_at": null,
"id": null,
"section_type": null,
"updated_at": null,
"version": null
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
}
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": null
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": null
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": null,
"created_at": null,
"deleted_at": null,
"id": null,
"section_type": null,
"updated_at": null,
"version": null
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
]
}
}

Delete trigger

Delete trigger by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Trigger unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "Unauthenticated."
}

Workflow/Trigger/TriggerEventCondition

TriggerEventCondition – API for creating, deleting, and editing conditions related to a trigger. These conditions serve as the main rules for launching a workflow.

Create Trigger Event Condition

Create a new Trigger Event Condition

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

trigger_id required	integer Trigger unique identifier
event_definition_id	integer EventDefinition unique identifier
segment_id	integer Segment unique identifier

Responses

Response Schema: application/json

object (TriggerEventConditionResource)

Schema of the TriggerEventCondition structure.

created_at	string <date-time> Date and time of creation.
	(EventDefinitionResource (object or null)) The EventDefinition to which it belongs.
id	integer TriggerEventCondition unique identifier
	(SegmentResource (object or null)) The Segment to which it belongs.
	(TriggerResource (object or null)) The Trigger to which it belongs.
updated_at	string <date-time> Date and time of modification.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"event_definition_id": "1",
"segment_id": "1",
"trigger_id": "1"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
}
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
},
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"stepExecutions": [null
],
"step_order": 0,
"template": {"category": null,
"contents": [ ],
"created_at": null,
"deleted_at": null,
"id": null,
"is_dispute": null,
"name": null,
"preview_content": null,
"type": null,
"updated_at": null
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
},
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": null,
"created_at": null,
"extension": null,
"id": null,
"size": null,
"type": null,
"url": null
}
],
"attributes": [{"name": null,
"value": null
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
}
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete Trigger Event Condition

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

TriggerEventCondition unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "Unauthenticated."
}

Update Trigger Event Condition

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

TriggerEventCondition unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

event_definition_id	integer EventDefinition unique identifier
segment_id	integer Segment unique identifier

Responses

Response Schema: application/json

object (TriggerEventConditionResource)

Schema of the TriggerEventCondition structure.

created_at	string <date-time> Date and time of creation.
	(EventDefinitionResource (object or null)) The EventDefinition to which it belongs.
id	integer TriggerEventCondition unique identifier
	(SegmentResource (object or null)) The Segment to which it belongs.
	(TriggerResource (object or null)) The Trigger to which it belongs.
updated_at	string <date-time> Date and time of modification.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"event_definition_id": "1",
"segment_id": "1"
}

Response samples

Content type

application/json

{"data": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": { },
"created_at": null,
"eventDefinition": null,
"id": null,
"is_children": null,
"name": null,
"nextStepOnFailure": null,
"nextStepOnSuccess": null,
"on_fail_exit": null,
"segment": null,
"stepExecutions": [ ],
"step_order": null,
"template": null,
"type": null,
"updated_at": null,
"workflow": null
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
}
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
},
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"stepExecutions": [null
],
"step_order": 0,
"template": {"category": null,
"contents": [ ],
"created_at": null,
"deleted_at": null,
"id": null,
"is_dispute": null,
"name": null,
"preview_content": null,
"type": null,
"updated_at": null
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
},
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": null,
"created_at": null,
"extension": null,
"id": null,
"size": null,
"type": null,
"url": null
}
],
"attributes": [{"name": null,
"value": null
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
}
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
}

Workflow

API Endpoints for managing workflows

Get Workflow list

Get Workflow list by filters and pagination

Authorizations:

bearerAuthx-api-key

query Parameters

can_run_concurrently	integer Enum: 1 0 Concurrency status, 1 - Yes, 0 - No
id	integer Workflow unique identifier
contract_id	integer Contract unique identifier
parent_id	integer Workflow Parent unique identifier
name	string Flow name
completion_status	string Enum: "draft" "completed" Filter by status
created_at	string <date-time> Date created
max_duration	integer Enum: 1 0 Frequency, 0 - only once, 1 - infinitely
segment_id	integer Segment unique identifier
created_by	integer Created by (User) unique identifier
last_modified_by	integer Last modified by (User) unique identifier
updated_at	string <date-time> Last modified date
search	string Search by name or description
is_archive	integer Enum: 1 0 Filter by archive status
is_active	integer Enum: 1 0 Filter by active status
exit_on_trigger_mismatch	integer Enum: 1 0 Exit on trigger mismatch
parent_id	integer Workflow parent unique identifier, If you want to get the list of versions for a given workflow, simply reference this field and sort by the `version_number` field.
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (WorkflowResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"stepExecutions": [null
],
"step_order": 0,
"template": {"category": null,
"contents": [ ],
"created_at": null,
"deleted_at": null,
"id": null,
"is_dispute": null,
"name": null,
"preview_content": null,
"type": null,
"updated_at": null
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": null,
"created_at": null,
"extension": null,
"id": null,
"size": null,
"type": null,
"url": null
}
],
"attributes": [{"name": null,
"value": null
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": null
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Create a Workflow

Create a new Workflow

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

name required	string [ 3 .. 255 ] characters
can_run_concurrently required	boolean Default: 1 Enum: 1 0 Concurrency status, 1 - Yes, 0 - No
exit_on_trigger_mismatch required	boolean Default: 1 Enum: 1 0 Exit on trigger mismatch
max_duration required	integer Default: 1 Enum: 1 0 Frequency, 0 - only once, 1 - infinitely
is_archive required	boolean Default: 0 Enum: 1 0 Is archive?
description	string or null <= 1000 characters
type	string or null Default: "client" Enum: "client" "negative_item" Workflow type

Responses

Response Schema: application/json

object (WorkflowResource)

Workflow resource representation

can_run_concurrently	boolean Can run concurrently?
completion_status	string Workflow completion status
	object (User) User object
created_at	string <date-time> Date and time of creation.
description	string or null Workflow description
exit_on_trigger_mismatch	boolean Exit on trigger mismatch?
id	integer Workflow unique identifier
is_active	boolean Is active?
is_archive	boolean Is archive?
is_version	boolean Is version?
	(User (object or null)) The user who updated the workflow.
max_duration	integer Max duration
name	string Workflow name
	Array of objects or null (WorkflowStepResource) Workflow steps list
	(TriggerResource (object or null)) Workflow trigger
type	string Enum: "client" "negative_item" Workflow type
updated_at	string <date-time> Date and time of modification.
	Array of objects or null (WorkflowInstanceResource) WorkflowInstances list
	Array of objects or null (WorkflowNoteResource) Workflow notes list

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"can_run_concurrently": 1,
"description": "string",
"exit_on_trigger_mismatch": 1,
"is_archive": 1,
"max_duration": 1,
"name": "string",
"type": "client"
}

Response samples

Content type

application/json

{"data": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": null,
"created_at": null,
"extension": null,
"id": null,
"size": null,
"type": null,
"url": null
}
],
"attributes": [{"name": null,
"value": null
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": null,
"created_at": null,
"deleted_at": null,
"id": null,
"section_type": null,
"updated_at": null,
"version": null
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}

Delete an Workflow

Delete Workflow by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Workflow unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "Unauthenticated."
}

Get workflow

Get workflow full information by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Workflow unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (WorkflowResource)

Workflow resource representation

can_run_concurrently	boolean Can run concurrently?
completion_status	string Workflow completion status
	object (User) User object
created_at	string <date-time> Date and time of creation.
description	string or null Workflow description
exit_on_trigger_mismatch	boolean Exit on trigger mismatch?
id	integer Workflow unique identifier
is_active	boolean Is active?
is_archive	boolean Is archive?
is_version	boolean Is version?
	(User (object or null)) The user who updated the workflow.
max_duration	integer Max duration
name	string Workflow name
	Array of objects or null (WorkflowStepResource) Workflow steps list
	(TriggerResource (object or null)) Workflow trigger
type	string Enum: "client" "negative_item" Workflow type
updated_at	string <date-time> Date and time of modification.
	Array of objects or null (WorkflowInstanceResource) WorkflowInstances list
	Array of objects or null (WorkflowNoteResource) Workflow notes list

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": null,
"created_at": null,
"extension": null,
"id": null,
"size": null,
"type": null,
"url": null
}
],
"attributes": [{"name": null,
"value": null
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": null,
"created_at": null,
"deleted_at": null,
"id": null,
"section_type": null,
"updated_at": null,
"version": null
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}

Update workflow

Update workflow details by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Workflow unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

can_run_concurrently	boolean Default: 1 Enum: 1 0 Concurrency status, 1 - Yes, 0 - No
completion_status	string or null Enum: "draft" "completed" Workflow activation is only available if the workflow is in the "completed" status.
description	string or null <= 1000 characters
exit_on_trigger_mismatch	boolean Default: 1 Enum: 1 0 Exit on trigger mismatch
is_active	boolean or null Default: 1 Enum: 1 0
is_archive	boolean or null Default: 0 Enum: 1 0
max_duration	integer Enum: 1 0 Frequency, 0 - only once, 1 - infinitely
name	string or null [ 3 .. 255 ] characters
type	string or null Enum: "client" "negative_item" Workflow type
workflow_id	integer or null The ID of the workflow that is a version of the current one, used for reverting to that version.

Responses

Response Schema: application/json

object (WorkflowResource)

Workflow resource representation

can_run_concurrently	boolean Can run concurrently?
completion_status	string Workflow completion status
	object (User) User object
created_at	string <date-time> Date and time of creation.
description	string or null Workflow description
exit_on_trigger_mismatch	boolean Exit on trigger mismatch?
id	integer Workflow unique identifier
is_active	boolean Is active?
is_archive	boolean Is archive?
is_version	boolean Is version?
	(User (object or null)) The user who updated the workflow.
max_duration	integer Max duration
name	string Workflow name
	Array of objects or null (WorkflowStepResource) Workflow steps list
	(TriggerResource (object or null)) Workflow trigger
type	string Enum: "client" "negative_item" Workflow type
updated_at	string <date-time> Date and time of modification.
	Array of objects or null (WorkflowInstanceResource) WorkflowInstances list
	Array of objects or null (WorkflowNoteResource) Workflow notes list

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"can_run_concurrently": 1,
"completion_status": "draft",
"description": "string",
"exit_on_trigger_mismatch": 1,
"is_active": 1,
"is_archive": 1,
"max_duration": 1,
"name": "string",
"type": "client",
"workflow_id": 0
}

Response samples

Content type

application/json

{"data": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": null,
"created_at": null,
"extension": null,
"id": null,
"size": null,
"type": null,
"url": null
}
],
"attributes": [{"name": null,
"value": null
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": null,
"created_at": null,
"deleted_at": null,
"id": null,
"section_type": null,
"updated_at": null,
"version": null
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}

Clone a Workflow

Clone a Workflow with trigger, triggerCondition, steps

Authorizations:

bearerAuthx-api-key

path Parameters

workflow

required

integer <int64>

Workflow unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (WorkflowResource)

Workflow resource representation

can_run_concurrently	boolean Can run concurrently?
completion_status	string Workflow completion status
	object (User) User object
created_at	string <date-time> Date and time of creation.
description	string or null Workflow description
exit_on_trigger_mismatch	boolean Exit on trigger mismatch?
id	integer Workflow unique identifier
is_active	boolean Is active?
is_archive	boolean Is archive?
is_version	boolean Is version?
	(User (object or null)) The user who updated the workflow.
max_duration	integer Max duration
name	string Workflow name
	Array of objects or null (WorkflowStepResource) Workflow steps list
	(TriggerResource (object or null)) Workflow trigger
type	string Enum: "client" "negative_item" Workflow type
updated_at	string <date-time> Date and time of modification.
	Array of objects or null (WorkflowInstanceResource) WorkflowInstances list
	Array of objects or null (WorkflowNoteResource) Workflow notes list

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": null,
"created_at": null,
"extension": null,
"id": null,
"size": null,
"type": null,
"url": null
}
],
"attributes": [{"name": null,
"value": null
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": null,
"created_at": null,
"deleted_at": null,
"id": null,
"section_type": null,
"updated_at": null,
"version": null
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}

Simulate workflow

Simulation of a workflow execution for a client, with the option to run it either with or without considering an event. It also supports passing custom fields required for execution steps (when simulating with an event).

Authorizations:

bearerAuthx-api-key

path Parameters

workflow required	integer <int64> Workflow unique identifier
client required	integer <int64> Client unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

event_definition_name

string or null

EventDefinition name

Responses

Response Schema: application/json

	Array of objects
message	string

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"event_definition_name": "string"
}

Response samples

Content type

application/json

{"data": [{"context": {"event_definition_name": null,
"event_id": null,
"workflow_id": 1,
"workflow_instance_id": 1,
"workflow_step_id": 1,
"workflow_step_name": "Example name"
},
"level": "INFO",
"message": "A task is being created to execute the initial step of the workflow."
}
],
"message": "Operation successfully."
}

Get Event from Workflow

Endpoint for receiving events from Workflow

Authorizations:

workflowEventReceivingx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

client_id	integer or null Client unique identifier
event_definition_name	string EventDefinition name
event_portal_id	integer or null Event unique identifier
negative_item_id	integer or null Negative Item unique identifier

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"client_id": 0,
"event_definition_name": "string",
"event_portal_id": 0,
"negative_item_id": 0
}

Response samples

Content type

application/json

{"message": "string"
}

WorkflowInstance

The API is designed to retrieve Instances of completed Workflows, with filtering available by Client and the workflow itself.

Get Client Workflow Instances

Retrieve all Workflow Instances assigned to a Client

Authorizations:

bearerAuthx-api-key

path Parameters

client

required

integer

Example: 1

Client unique identifier

query Parameters

workflow_id	integer Workflow unique identifier
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (WorkflowInstanceResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": null
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": null
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": null,
"created_at": null,
"deleted_at": null,
"id": null,
"section_type": null,
"updated_at": null,
"version": null
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get Workflow Instances

Retrieve all Workflow Instances assigned to a Workflow

Authorizations:

bearerAuthx-api-key

path Parameters

workflow

required

integer

Example: 1

Workflow unique identifier

query Parameters

client_id	integer Client unique identifier
per_page	integer Number of records per page. For example, if you want to see 10 records per page, you should enter the number 10 here. By default, this value is 15.
page	integer Page number.
sort_direction	string Enum: "asc" "desc" Sort order, where "asc" is ascending and "desc" is descending.
sort_by	string The field by which you want to sort the pages, for example by size, creation date, modification date, type, etc.

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (WorkflowInstanceResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": null
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": null
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": null,
"created_at": null,
"deleted_at": null,
"id": null,
"section_type": null,
"updated_at": null,
"version": null
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

WorkflowNote

API Endpoints for managing workflow notes

Create a WorkflowNote

Create a new WorkflowNote

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

workflow_id required	integer Workflow unique identifier
content required	string [ 3 .. 3000 ] characters
coordinate_x required	number <float>
coordinate_y required	number <float>
width required	number <float> >= 50
height required	number <float> >= 30

Responses

Response Schema: application/json

object (WorkflowNoteResource)

Workflow Note resource representation

	(User (object or null)) The user who created or last updated the note.
content	string WorkflowNote content
coordinate_x	number <float> WorkflowNote coordinate x
coordinate_y	number <float> WorkflowNote coordinate y
created_at	string <date-time> Date and time of creation.
height	number <float> WorkflowNote height
id	integer WorkflowNote unique identifier
updated_at	string <date-time> Date and time of modification.
width	number <float> WorkflowNote width
	(WorkflowResource (object or null)) Workflow resource

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"content": "string",
"coordinate_x": 1.1,
"coordinate_y": 1.1,
"height": 100,
"width": 200,
"workflow_id": 0
}

Response samples

Content type

application/json

{"data": {"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"stepExecutions": [null
],
"step_order": 0,
"template": {"category": null,
"contents": [ ],
"created_at": null,
"deleted_at": null,
"id": null,
"is_dispute": null,
"name": null,
"preview_content": null,
"type": null,
"updated_at": null
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": null,
"created_at": null,
"extension": null,
"id": null,
"size": null,
"type": null,
"url": null
}
],
"attributes": [{"name": null,
"value": null
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{ }
]
}
}
}

Delete an WorkflowNote

Delete WorkflowNote by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

WorkflowNote unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "Unauthenticated."
}

Update WorkflowNote

Update WorkflowNote details by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

WorkflowNote unique identifier

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

content required	string [ 3 .. 3000 ] characters
coordinate_x required	number <float>
coordinate_y required	number <float>
width required	number <float> >= 50
height required	number <float> >= 30

Responses

Response Schema: application/json

object (WorkflowNoteResource)

Workflow Note resource representation

	(User (object or null)) The user who created or last updated the note.
content	string WorkflowNote content
coordinate_x	number <float> WorkflowNote coordinate x
coordinate_y	number <float> WorkflowNote coordinate y
created_at	string <date-time> Date and time of creation.
height	number <float> WorkflowNote height
id	integer WorkflowNote unique identifier
updated_at	string <date-time> Date and time of modification.
width	number <float> WorkflowNote width
	(WorkflowResource (object or null)) Workflow resource

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"content": "string",
"coordinate_x": 1.1,
"coordinate_y": 1.1,
"height": 100,
"width": 200
}

Response samples

Content type

application/json

{"data": {"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"stepExecutions": [null
],
"step_order": 0,
"template": {"category": null,
"contents": [ ],
"created_at": null,
"deleted_at": null,
"id": null,
"is_dispute": null,
"name": null,
"preview_content": null,
"type": null,
"updated_at": null
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{"caption": null,
"created_at": null,
"extension": null,
"id": null,
"size": null,
"type": null,
"url": null
}
],
"attributes": [{"name": null,
"value": null
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": {"config": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{ }
],
"step_order": 0,
"template": {"category": {"created_at": null,
"id": null,
"name": null,
"updated_at": null
},
"contents": [null
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{ }
]
}
}
}

WorkflowStep

API for managing WorkflowSteps that allows creating, updating, and deleting steps.

Get workflow step list

Retrieve a list of Workflow Steps for a specific Workflow

Authorizations:

bearerAuthx-api-key

query Parameters

workflow_id required	integer Workflow id
search	string Search by name or description
sort_by	string Default: "id" Sort by field (id, name, description, created_at)
sort_direction	string Default: "desc" Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Default: 1 Page number
per_page	integer Default: 15 Items per page

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (WorkflowStepResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": null,
"completion_status": null,
"createdBy": null,
"created_at": null,
"description": null,
"exit_on_trigger_mismatch": null,
"id": null,
"is_active": null,
"is_archive": null,
"is_version": null,
"lastModifiedBy": null,
"max_duration": null,
"name": null,
"steps": [ ],
"trigger": null,
"type": null,
"updated_at": null,
"workflowInstances": [ ],
"workflowNotes": [ ]
},
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
}
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
},
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
},
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": null,
"completion_status": null,
"createdBy": null,
"created_at": null,
"description": null,
"exit_on_trigger_mismatch": null,
"id": null,
"is_active": null,
"is_archive": null,
"is_version": null,
"lastModifiedBy": null,
"max_duration": null,
"name": null,
"steps": [ ],
"trigger": null,
"type": null,
"updated_at": null,
"workflowInstances": [ ],
"workflowNotes": [ ]
}
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Bulk Create Workflow Steps

Create multiple Workflow Steps at once with automatic next_step_on_success linking

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

	Array of objects (Create Workflow Step) Array of workflow steps to create
workflow_id	integer Workflow ID

Responses

Response Schema: application/json

	Array of objects (WorkflowStepResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"steps": [{"config": {"attributes": [{"name": "string",
"value": "string"
}
],
"body": { },
"contract_id": 0,
"days": 90,
"description": "string",
"due_date": 60,
"headers": { },
"hours": 23,
"include_id_document": 0,
"loop": {"count_repeats": 0,
"exit_segment": 1,
"iteration_time_days": 0,
"iteration_time_hours": 23,
"iteration_time_minutes": 59,
"iteration_time_months": 0,
"iteration_time_weeks": 0,
"steps": [{"workflow_step_id": 1
}
]
},
"method": "POST",
"minutes": 59,
"note_text": "string",
"operator": "contains",
"priority": "Critical",
"send_to": "email",
"sms_number": "+380931234567",
"status_from": "Open",
"status_to": "Closed",
"subject": "string",
"task_name": "string",
"template": 1,
"template_id": 1,
"url": "https://api.example.com/notify"
},
"event_definition_id": "1",
"is_children": 0,
"name": "Step notification partner about something.",
"next_step_on_failure": 1,
"next_step_on_success": 1,
"on_fail_exit": 1,
"segment_id": "1",
"step_order": 1,
"type": "http_request",
"workflow_id": 1
}
],
"workflow_id": 1
}

Response samples

Content type

application/json

{"data": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": null,
"completion_status": null,
"createdBy": null,
"created_at": null,
"description": null,
"exit_on_trigger_mismatch": null,
"id": null,
"is_active": null,
"is_archive": null,
"is_version": null,
"lastModifiedBy": null,
"max_duration": null,
"name": null,
"steps": [ ],
"trigger": null,
"type": null,
"updated_at": null,
"workflowInstances": [ ],
"workflowNotes": [ ]
},
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
}
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
},
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
},
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": null,
"completion_status": null,
"createdBy": null,
"created_at": null,
"description": null,
"exit_on_trigger_mismatch": null,
"id": null,
"is_active": null,
"is_archive": null,
"is_version": null,
"lastModifiedBy": null,
"max_duration": null,
"name": null,
"steps": [ ],
"trigger": null,
"type": null,
"updated_at": null,
"workflowInstances": [ ],
"workflowNotes": [ ]
}
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Bulk Update Workflow Steps

Bulk update workflow steps with CREATE, UPDATE, DELETE operations based on ID presence. Handles cascade deletion for multi_step and loop children.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

workflow_id required	integer Workflow ID
required	Array of objects (Create Workflow Step) non-empty Array of workflow steps to create

Responses

Response Schema: application/json

	Array of objects (WorkflowStepResource)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"steps": [{"config": {"attributes": [{"name": "string",
"value": "string"
}
],
"body": { },
"contract_id": 0,
"days": 90,
"description": "string",
"due_date": 60,
"headers": { },
"hours": 23,
"include_id_document": 0,
"loop": {"count_repeats": 0,
"exit_segment": 1,
"iteration_time_days": 0,
"iteration_time_hours": 23,
"iteration_time_minutes": 59,
"iteration_time_months": 0,
"iteration_time_weeks": 0,
"steps": [{"workflow_step_id": 1
}
]
},
"method": "POST",
"minutes": 59,
"note_text": "string",
"operator": "contains",
"priority": "Critical",
"send_to": "email",
"sms_number": "+380931234567",
"status_from": "Open",
"status_to": "Closed",
"subject": "string",
"task_name": "string",
"template": 1,
"template_id": 1,
"url": "https://api.example.com/notify"
},
"event_definition_id": "1",
"is_children": 0,
"name": "Step notification partner about something.",
"next_step_on_failure": 1,
"next_step_on_success": 1,
"on_fail_exit": 1,
"segment_id": "1",
"step_order": 1,
"type": "http_request",
"workflow_id": 1,
"steps": [{"config": {"attributes": [{"name": "string",
"value": "string"
}
],
"body": { },
"contract_id": 0,
"days": 90,
"description": "string",
"due_date": 60,
"headers": { },
"hours": 23,
"include_id_document": 0,
"loop": {"count_repeats": 0,
"exit_segment": 1,
"iteration_time_days": 0,
"iteration_time_hours": 23,
"iteration_time_minutes": 59,
"iteration_time_months": 0,
"iteration_time_weeks": 0,
"steps": [{"workflow_step_id": 1
}
]
},
"method": "POST",
"minutes": 59,
"note_text": "string",
"operator": "contains",
"priority": "Critical",
"send_to": "email",
"sms_number": "+380931234567",
"status_from": "Open",
"status_to": "Closed",
"subject": "string",
"task_name": "string",
"template": 1,
"template_id": 1,
"url": "https://api.example.com/notify"
},
"event_definition_id": "1",
"is_children": 0,
"name": "Step notification partner about something.",
"next_step_on_failure": 1,
"next_step_on_success": 1,
"on_fail_exit": 1,
"segment_id": "1",
"step_order": 1,
"type": "http_request",
"workflow_id": 1
}
],
"step_id": 123
}
],
"workflow_id": 1
}

Response samples

Content type

application/json

{"data": [{"config": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"context": {"variable": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": { },
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [null
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": null,
"not_dispute": null,
"status": null,
"updated_by": null
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": [null
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": null,
"created_at": null,
"end_time": null,
"error": { },
"id": null,
"result": { },
"retry_count": null,
"start_time": null,
"status": null,
"updated_at": null,
"workflow": null
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": null,
"completion_status": null,
"createdBy": null,
"created_at": null,
"description": null,
"exit_on_trigger_mismatch": null,
"id": null,
"is_active": null,
"is_archive": null,
"is_version": null,
"lastModifiedBy": null,
"max_duration": null,
"name": null,
"steps": [ ],
"trigger": null,
"type": null,
"updated_at": null,
"workflowInstances": [ ],
"workflowNotes": [ ]
},
"workflowInstances": [null
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"max_duration": 0,
"name": "string",
"steps": [null
],
"trigger": {"created_at": null,
"id": null,
"triggerEventCondition": null,
"type": null,
"updated_at": null,
"workflow": null,
"workflowInstances": [ ]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [null
],
"workflowNotes": [null
]
}
}
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": { },
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": { },
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": null,
"context": { },
"created_at": null,
"end_time": null,
"event": null,
"id": null,
"negativeItem": null,
"result": { },
"start_time": null,
"status": null,
"stepExecutions": [ ],
"trigger": null,
"updated_at": null,
"version_number": null,
"workflow": null
}
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
},
"workflowInstances": [{"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"context": {"variable": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": { },
"client": null,
"data": { },
"eventDefinition": null,
"id": null,
"occurred_at": null,
"processed_at": null,
"received_at": null,
"rudder_id": null,
"status": null,
"workflowInstances": [ ]
},
"id": 0,
"negativeItem": {"account_name": null,
"account_number": null,
"account_ownership_type": null,
"account_paid_date": null,
"account_status": null,
"account_type": null,
"bureau_tradeline_id": null,
"charge_off_date": null,
"client": null,
"client_key": null,
"close_date": null,
"collection_date": null,
"correspondence": [ ],
"credit_balance": null,
"credit_limit": null,
"credit_loan_type": null,
"credit_report_id": null,
"current_rateing_code": null,
"current_rating_type": null,
"high_balance_amount": null,
"high_credit_amount": null,
"highest_adverse_rating_code": null,
"highest_adverse_rating_type": null,
"internal_client_key": null,
"is_charge_off": null,
"is_closed": null,
"is_collection": null,
"is_disputed": null,
"is_mortgage": null,
"is_negative": null,
"is_revolving": null,
"is_secure_loan": null,
"last_activity_date": null,
"last_payment_date": null,
"late_count_30_days": null,
"late_count_60_days": null,
"late_count_90_days": null,
"loan_type": null,
"metadata": null,
"modified_date": null,
"monthly_payment": null,
"months_viewed": null,
"most_recent_adverse_rating_code": null,
"most_recent_adverse_rating_date": null,
"most_recent_adverse_rating_type": null,
"opened_date": null,
"original_balance_amount": null,
"past_due_amount": null,
"report_id": null,
"reported_date": null,
"terms_desc": null,
"terms_month": null,
"unpaid_balance_amount": null,
"vendor_tradeline_id": null
},
"result": {"variable": [ ]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [null
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": null,
"completion_status": null,
"createdBy": null,
"created_at": null,
"description": null,
"exit_on_trigger_mismatch": null,
"id": null,
"is_active": null,
"is_archive": null,
"is_version": null,
"lastModifiedBy": null,
"max_duration": null,
"name": null,
"steps": [ ],
"trigger": null,
"type": null,
"updated_at": null,
"workflowInstances": [ ],
"workflowNotes": [ ]
}
}
]
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"is_children": true,
"name": "string",
"nextStepOnFailure": { },
"nextStepOnSuccess": { },
"on_fail_exit": true,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": 0,
"field": "string",
"operator": "=",
"relation": "string",
"value": "string"
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": ["string"
]
},
"id": 0,
"result": {"variable": ["string"
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [null
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": null
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": { },
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": null,
"content": null,
"coordinate_x": null,
"coordinate_y": null,
"created_at": null,
"height": null,
"id": null,
"updated_at": null,
"width": null,
"workflow": null
}
]
},
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": null,
"name": null,
"permissions": [ ]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": null,
"description": null,
"events": [ ],
"id": null,
"name": null,
"schema": { },
"source": null,
"status": null,
"triggerEventConditions": [ ],
"updated_at": null
},
"id": 0,
"segment": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{ }
],
"workflowNotes": [{"author": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"last_name": null,
"roles": [ ],
"updated_at": null,
"user_access_log": null
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
}
],
"step_order": 0,
"template": {"category": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"contents": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"section_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_dispute": true,
"name": "string",
"preview_content": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "http_request",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": {"can_run_concurrently": true,
"completion_status": "string",
"createdBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"exit_on_trigger_mismatch": true,
"id": 0,
"is_active": true,
"is_archive": true,
"is_version": true,
"lastModifiedBy": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"max_duration": 0,
"name": "string",
"steps": [{ }
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{"attributes": {"property1": null,
"property2": null
},
"client": {"attributes": { },
"client_key": null,
"email": null,
"id": null,
"joint_customer_sf_id": null,
"mobile_phone": null,
"salesforce_id": null,
"segments": null,
"ssn": null
},
"data": {"variable": [ ]
},
"eventDefinition": { },
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [null
]
}
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": ["string"
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{ }
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [{"count_repeat": null,
"field": null,
"operator": null,
"relation": null,
"value": null
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"data": {"variable": [null
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": null,
"FirstName": null,
"Id": null,
"LastName": null,
"MiddleName": null
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": null,
"conditions": null,
"created_at": null,
"description": null,
"id": null,
"is_active": null,
"is_archive": null,
"name": null,
"negative_items_count": null,
"type": null,
"updated_at": null,
"usage_count": null
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [ ],
"attributes": [ ],
"client_id": null,
"id": null,
"negative_item_id": null,
"run_by": { },
"type": null
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [ ]
},
"id": 0,
"result": {"variable": [ ]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
]
},
"type": "client",
"updated_at": "2019-08-24T14:15:22Z",
"workflowInstances": [{"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": "AND",
"count_repeat": 0,
"not": 0,
"relation": "string",
"rules": [null
]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"context": {"variable": ["string"
]
},
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"event": {"attributes": {"property1": "John Doe",
"property2": "John Doe"
},
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"data": {"variable": ["string"
]
},
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [{ }
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [null
]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [{"created_at": null,
"eventDefinition": null,
"id": null,
"segment": null,
"trigger": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"occurred_at": "2019-08-24T14:15:22Z",
"processed_at": "2019-08-24T14:15:22Z",
"received_at": "2019-08-24T14:15:22Z",
"rudder_id": "string",
"status": "received",
"workflowInstances": [{ }
]
},
"id": 0,
"negativeItem": {"account_name": "string",
"account_number": "string",
"account_ownership_type": "string",
"account_paid_date": "2019-08-24",
"account_status": "string",
"account_type": "string",
"bureau_tradeline_id": "string",
"charge_off_date": "2019-08-24",
"client": {"attributes": {"Email": "user@example.com",
"FirstName": "string",
"Id": "string",
"LastName": "string",
"MiddleName": "string"
},
"client_key": "string",
"email": "string",
"id": 0,
"joint_customer_sf_id": "string",
"mobile_phone": "string",
"salesforce_id": 0,
"segments": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"ssn": 0
},
"client_key": "string",
"close_date": "2019-08-24",
"collection_date": "2019-08-24",
"correspondence": [{"attachments": [{ }
],
"attributes": [{ }
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": null,
"email": null,
"first_name": null,
"id": null,
"is_disabled": null,
"last_name": null
},
"type": "string"
}
],
"credit_balance": "string",
"credit_limit": "string",
"credit_loan_type": "string",
"credit_report_id": 0,
"current_rateing_code": "string",
"current_rating_type": "string",
"high_balance_amount": "string",
"high_credit_amount": "string",
"highest_adverse_rating_code": "string",
"highest_adverse_rating_type": "string",
"internal_client_key": "string",
"is_charge_off": true,
"is_closed": true,
"is_collection": true,
"is_disputed": true,
"is_mortgage": true,
"is_negative": true,
"is_revolving": true,
"is_secure_loan": true,
"last_activity_date": "2019-08-24",
"last_payment_date": "2019-08-24",
"late_count_30_days": 0,
"late_count_60_days": 0,
"late_count_90_days": 0,
"loan_type": "string",
"metadata": {"created_by": 0,
"not_dispute": true,
"status": "new",
"updated_by": 0
},
"modified_date": "string",
"monthly_payment": "string",
"months_viewed": 0,
"most_recent_adverse_rating_code": "string",
"most_recent_adverse_rating_date": "2019-08-24",
"most_recent_adverse_rating_type": "string",
"opened_date": "2019-08-24",
"original_balance_amount": "string",
"past_due_amount": "string",
"report_id": "string",
"reported_date": "2019-08-24",
"terms_desc": "string",
"terms_month": 0,
"unpaid_balance_amount": "string",
"vendor_tradeline_id": "string"
},
"result": {"variable": ["string"
]
},
"start_time": "2019-08-24T14:15:22Z",
"status": "running",
"stepExecutions": [{"client": { },
"created_at": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"error": {"variable": [null
]
},
"id": 0,
"result": {"variable": [null
]
},
"retry_count": 0,
"start_time": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { }
}
],
"trigger": {"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"triggerEventCondition": {"created_at": "2019-08-24T14:15:22Z",
"eventDefinition": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"events": [null
],
"id": 0,
"name": "string",
"schema": {"properties": { },
"required": [ ]
},
"source": "string",
"status": "draft",
"triggerEventConditions": [null
],
"updated_at": "2019-08-24T14:15:22Z"
},
"id": 0,
"segment": {"clients_count": 0,
"conditions": {"combinator": null,
"count_repeat": null,
"not": null,
"relation": null,
"rules": [ ]
},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"is_active": true,
"is_archive": true,
"name": "string",
"negative_items_count": 0,
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usage_count": 0
},
"trigger": { },
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "event",
"updated_at": "2019-08-24T14:15:22Z",
"workflow": { },
"workflowInstances": [{ }
]
},
"updated_at": "2019-08-24T14:15:22Z",
"version_number": 0,
"workflow": { }
}
],
"workflowNotes": [{"author": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [null
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"content": "string",
"coordinate_x": 0.1,
"coordinate_y": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"height": 0.1,
"id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"width": 0.1,
"workflow": { }
}
]
}
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Delete Workflow Step

Delete Workflow Step by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer <int64>

Workflow Step unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the requested resource could not be found.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "Unauthenticated."
}

Customer - Correspondence

Get correspondence list (for Customer Portal)

Get correspondence list with filtering, searching, and pagination options (for Customer Portal)

Authorizations:

CustomerBearerAuthx-api-key

path Parameters

client

required

integer

Client ID

query Parameters

type[]	Array of strings Items Enum: "fax" "email" "sms" "letter" Multiple types of correspondence. Allowed values: fax, email, sms, letter.
run_by	integer Fax sender (User) unique identifier
recipient	string Fax Recipient
fax_number	string Fax number
search	string Search query (e.g. value of: created_at, subject, run_by etc.)
sort_by	string Sort column field (e.g., created_at, subject, first_name etc.)
sort_direction	string Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Page number (e.g., 1)
per_page	integer Items per page (e.g., 10)

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

	Array of objects (CorrespondenceResponse)
	object (PaginationLinks)
	object (PaginationMeta)

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": [{"attachments": [{"caption": "string",
"created_at": "2019-08-24T14:15:22Z",
"extension": "string",
"id": 0,
"size": 0,
"type": "string",
"url": "string"
}
],
"attributes": [{"name": "string",
"value": "string"
}
],
"client_id": 0,
"id": 0,
"negative_item_id": 0,
"run_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": 0,
"is_disabled": true,
"last_name": "string"
},
"type": "string"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"active": true,
"label": "string",
"url": "http://example.com"
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Client Statuses

Get Client Status List

Returns a list of available client statuses.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (ClientStatusResponse)

label

string

Status label

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"label": "string"
}
}

Vendor Authentication Key

Get all Authentication Keys

Retrieve a paginated list of Authentication Keys with filtering and sorting options.

Authorizations:

bearerAuthx-api-key

query Parameters

search	string Search query (e.g. value of: api_key, vendor_name, created_by, created_at, expires_at)
sort_by	string Sort column field (e.g. api_key, vendor_name, created_by, created_at, expires_at)
sort_direction	string Enum: "asc" "desc" Sort direction (asc or desc)
page	integer Page number (e.g., 1)
per_page	integer Items per page (e.g., 10)

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

object (VendorAuthenticationKeyResponse)

api_key	string Vendor API key
created_at	string <date-time> Creation timestamp
	object (User) User object
expires_at	string <date-time> Expiration timestamp
id	integer Vendor Authentication key ID
is_active	boolean Is active
updated_at	string <date-time> Update timestamp
vendor_name	string Related Vendor name

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"data": {"api_key": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"expires_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_active": true,
"updated_at": "2019-08-24T14:15:22Z",
"vendor_name": "string"
}
}

Create a Vendor Authentication Key

Create a new vendor authentication key.

Authorizations:

bearerAuthx-api-key

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

Data to create a new Vendor Authentication Key

api_key	string API key
expires_at	string <date-time> Expiration timestamp
is_active	boolean Is active
vendor_name	string Related Vendor name

Responses

Response Schema: application/json

object (VendorAuthenticationKeyResponse)

api_key	string Vendor API key
created_at	string <date-time> Creation timestamp
	object (User) User object
expires_at	string <date-time> Expiration timestamp
id	integer Vendor Authentication key ID
is_active	boolean Is active
updated_at	string <date-time> Update timestamp
vendor_name	string Related Vendor name

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"api_key": "string",
"expires_at": "2019-08-24T14:15:22Z",
"is_active": true,
"vendor_name": "string"
}

Response samples

Content type

application/json

{"data": {"api_key": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"expires_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_active": true,
"updated_at": "2019-08-24T14:15:22Z",
"vendor_name": "string"
}
}

Delete an Authentication Key

Delete Vendor Authentication Key by unique identifier

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Vendor Authentication key unique identifier

header Parameters

x-api-key

required

string

Responses

Response Schema: application/json

message

string

Message indicating successful request execution.

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Response samples

Content type

application/json

{"message": "string"
}

Update a Authentication Key

Updates an existing vendor authentication key by unique identifier.

Authorizations:

bearerAuthx-api-key

path Parameters

id

required

integer

Vendor Authentication Key id

header Parameters

x-api-key

required

string

Request Body schema: application/json
required

api_key	string <= 255 characters API key
expires_at	string <date-time> Expiration timestamp
is_active	boolean Default: true Is active
vendor_name	string <= 255 characters Related Vendor name

Responses

Response Schema: application/json

object (VendorAuthenticationKeyResponse)

api_key	string Vendor API key
created_at	string <date-time> Creation timestamp
	object (User) User object
expires_at	string <date-time> Expiration timestamp
id	integer Vendor Authentication key ID
is_active	boolean Is active
updated_at	string <date-time> Update timestamp
vendor_name	string Related Vendor name

Response Schema: application/json

message

string

A general message indicating the authentication issue.

Response Schema: application/json

message

string

A message indicating that the user is not authorized to perform the requested action.

Response Schema: application/json

message

string

A message indicating that the session has expired.

Response Schema: application/json

	object A collection of validation errors where keys are field names and values are lists of error messages.
message	string A general message describing the validation error

Response Schema: application/json

message

string

A message indicating that an internal server error has occurred.

Request samples

Payload

Content type

application/json

{"api_key": "string",
"expires_at": "2019-08-24T14:15:22Z",
"is_active": true,
"vendor_name": "string"
}

Response samples

Content type

application/json

{"data": {"api_key": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": {"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"first_name": "string",
"id": 0,
"last_name": "string",
"roles": [{"id": "string",
"name": "string",
"permissions": [{"name": "string"
}
]
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_access_log": {"last_login_at": "2019-08-24T14:15:22Z"
}
},
"expires_at": "2019-08-24T14:15:22Z",
"id": 0,
"is_active": true,
"updated_at": "2019-08-24T14:15:22Z",
"vendor_name": "string"
}
}

Stg Portal 2.0 API Refactoring (1.0.0)

Attachment

Get list of attachments

Authorizations:

query Parameters

header Parameters

Responses

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response samples

Upload an attachment

Authorizations:

header Parameters

Request Body schema: multipart/form-datarequired

Responses

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response samples

Delete an attachment

Authorizations:

path Parameters

header Parameters

Responses

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response samples

Get an attachment

Authorizations:

path Parameters

header Parameters

Responses

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response samples

Download attachment

Authorizations:

path Parameters

header Parameters

Responses

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response samples

AttachmentEntity

Assigning an attachment to an entity

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Request samples

Response samples

Remove an attachment from an entity

Authorizations:

path Parameters

header Parameters

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required