API References

Account

Campaign

Contact

Flow

LoginLink

Send

SuppressionList

SuppressionListContact

Template

Webhook

Enroll Contact To Flow

POST

/ api/ v1/ flow/ {endPoint}

Add a new contact to the specified flow

endPoint

string

required

EndpointId of the flow to use in unenroll.

object

address_city

string

required

Recipient’s city, can be up to 100 characters long

Example:

New York

address_state

string

required

Recipient’s state, must be a 2-letter state short-name code or a valid full nam

Example:

NY

address_street

string

required

Recipient’s street, can be up to 100 characters long

Example:

36 Pipers Row

address_zip

string

required

Recipient’s zip code, must be in valid zip format

Example:

10001

first_name

string

required

Recipient’s first name must be between 1 and 50 characters long.

Example:

Thomas

last_name

string

required

Recipient’s last name must be between 1 and 50 characters long.

Example:

Anderson

address_street2

string

nullable

Recipient’s address 2. If provided, can be up to 100 characters long.

Example:

Room 101

company

string

nullable

Recipient’s company. If provided, re can be up to 100 characters long.

Example:

Metacortex

email_address

string

nullable

Recipient’s email. If provided, can be up to 100 characters long.

Example:

tanderson@metacortex.net

mobile_phone

string

nullable

Recipient’s mobile phone, can be up to 100 characters long

Example:

888-574-7346

occupation

string

nullable

Recipient’s occupation, can be up to 100 characters long

Example:

programmer

phone

string

nullable

Recipient’s phone. If provided, can be up to 100 characters long.

Example:

888-574-7346

var_field_1

string

nullable

Any string up to 255 characters.

var_field_10

string

nullable

Any string up to 255 characters.

var_field_11

string

nullable

Any string up to 255 characters.

var_field_12

string

nullable

Any string up to 255 characters.

var_field_13

string

nullable

Any string up to 255 characters.

var_field_14

string

nullable

Any string up to 255 characters.

var_field_15

string

nullable

Any string up to 255 characters.

var_field_16

string

nullable

Any string up to 255 characters.

var_field_17

string

nullable

Any string up to 255 characters.

var_field_18

string

nullable

Any string up to 255 characters.

var_field_19

string

nullable

Any string up to 255 characters.

var_field_2

string

nullable

Any string up to 255 characters.

var_field_20

string

nullable

Any string up to 255 characters.

var_field_21

string

nullable

Any string up to 255 characters.

var_field_22

string

nullable

Any string up to 255 characters.

var_field_23

string

nullable

Any string up to 255 characters.

var_field_24

string

nullable

Any string up to 255 characters.

var_field_25

string

nullable

Any string up to 255 characters.

var_field_26

string

nullable

Any string up to 255 characters.

var_field_27

string

nullable

Any string up to 255 characters.

var_field_28

string

nullable

Any string up to 255 characters.

var_field_29

string

nullable

Any string up to 255 characters.

var_field_3

string

nullable

Any string up to 255 characters.

var_field_30

string

nullable

Any string up to 255 characters.

var_field_31

string

nullable

Any string up to 255 characters.

var_field_32

string

nullable

Any string up to 255 characters.

var_field_33

string

nullable

Any string up to 255 characters.

var_field_34

string

nullable

Any string up to 255 characters.

var_field_35

string

nullable

Any string up to 255 characters.

var_field_4

string

nullable

Any string up to 255 characters.

var_field_5

string

nullable

Any string up to 255 characters.

var_field_6

string

nullable

Any string up to 255 characters.

var_field_7

string

nullable

Any string up to 255 characters.

var_field_8

string

nullable

Any string up to 255 characters.

var_field_9

string

nullable

Any string up to 255 characters.

website

string

nullable

Recipient’s website, can be up to 100 characters long

Example:

metacortex.net

Response

application/json

object

contactListId

integer (int32)

The id of the contactlist associated with this flow.

Example:

10142067

createDate

string (date-time)

The date and time when the flow was created.

Example:

1999-02-19T12:00:00.00:00

endpointId

string

nullable

The endpointId of the flow.

Example:

10142067

flowId

integer (int32)

The id of the flow.

Example:

10142067

isActive

boolean

Active status of the flow. 1 = published and active, 0 = draft mode

Example:

1

lastModifiedDate

string (date-time)

The date and time when the flow was last modified.

Example:

1999-02-19T12:00:00.00:00

name

string

nullable

The name of the flow.

Example:

Keymaker

send_date

string (date-time)

The date when the contact was enrolled on this flow

Example:

1999-02-19T12:00:00.00:00

Code Examples

Response