Send sequence

post

https://api.inputkit.io/v3/send/{sequence-id}

Send a sequence to a customer. Your sending intent is queued before being sent and an id is provided.

Path Params

sequence-id

string

required

ID of the sequence to send. The sequence have to be active.

Body Params

location_id

int32

required

The location ID of the client. If not specified, the client's location will default to the first unarchived location of the company.

creation_source

string

required

Defaults to Quickbooks

The name of the software where the customer comes from

string

Customer's email address. If multiple email addresses are provided, only the first one will be considered.

phone

string

Customer's mobile phone number. If multiple phone numbers are provided, only the first one will be considered.

sending_modes

string

Defaults to EMAIL

EMAIL by default. A value of either EMAIL, SMS or EMAIL,SMS

time_to_send

date

Specifies the date and time to send in UTC (UTC+0). Use null to send immediately. If a past date/time is provided, it defaults to the current time (NOW). Accepted formats are YYYY-MM-DD, YYYY-MM-DD HH:mm, YYYY-MM-DD HH:mm:ss, YYYY-MM-DD HH:mm:ss Z, YYYY-MM-DD HH:mm:ssZ, or the ISO-8601 format YYYY-MM-DDTHH:mm:ssZ (where Z indicates UTC and timezone offsets such as +00:00 are also supported). Invalid formats or values will be set to null.

customer_external_code

string

The external code of the customer. Max length: 45 chars. Values exceeding this limit will be truncated.

first_name

string

Customer's first name

last_name

string

Customer's last name

full_name

string

Customer's full name. Only if first and last names are empty

honorific

string

Customer's honorific (Mr. Ms. etc.)

locale

string

Locale of the client, ex: 'fr' or 'en'

employees

string

Employee(s) in charge. Names separated by comma. Employee type after semicolon (optional). Example: John Doe;Therapist

departments

string

Department(s) involved. Names separated by comma

organization_external_code

string

The external code of the customer's organization. Max length: 45 chars. Values exceeding this limit will be truncated.

organization

string

Customer's organization

is_test_mode

int32

1 to create a sending in test mode. It will appear in the sending lists but no sms or email are sent to the client. 0 to create a sending. Not a mandatory field

client_experience_date

date

If defined, we check the difference with the time to send (if it's also defined). If it is more than 30 days, the sending is rejected. Valid formats are YYYY-MM-DD, YYYY-MM-DD HH:mm or YYYY-MM-DD HH:mm:ss. Otherwise it is set to null.

monetary_value

double

The monetary value of the interaction wtih the client

gender

string

The gender of the client, ex: 'm', 'f'

Any other custom field

string

Any other custom field

Response

200200