Vixiees API

Sections

Theme switcher

Updates a contact's current playbook

Header Parameters

X-Api-Keystring

Path Parameters

idstring Required

The ID or external reference ID of the contact

Body Parameters

playbook_idstring Required
flow_step_idstring
contact_required_fieldsarray

Optional array of contact fields to update along with the playbook change

Show child attributes

Response

200
Object

playbook updated with contact required fields

Response Attributes

idstring
first_namestring | null
last_namestring | null
second_last_namestring | null
emailstring | null
phonestring | null
company_namestring | null
additional_phonesarray | null

Show child attributes

additional_emailsarray | null

Show child attributes

priorityinteger | null
sourcestring | null
country_codestring | null
languagestring | null
whatsapp_transactional_opt_inboolean | null
email_transactional_opt_inboolean | null
whatsapp_marketing_opt_inboolean | null
email_marketing_opt_inboolean | null
external_reference_idstring | null
external_reference_urlstring | null
ignoredboolean | null
is_clientboolean | null
last_close_won_reasonstring | null
last_close_lost_reasonstring | null
skillsarray | null

Show child attributes

created_atstring | null
updated_atstring | null
titlestring | null
closed_won_reasonstring | null
closed_lost_reasonstring | null
custom_attributesarray | null

Show child attributes

401
Object

unauthorized

404
Object

contact not found

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?