Skip to main content

Execute CDP Action

Returns Contact if the cdpActionType is one of CREATE_CONTACT | UPDATE_CONTACT | FILTER_CONTACTS. Returns List of Contact if the cdpActionType is one of DELETE_CONTACT | ADD_TAGS_TO_CONTACT | REMOVE_TAGS_FROM_CONTACT | FILTER_CONTACTS. Returns "Success" if the cdpActionType is DELETE_CONTACT. Returns List of ContactTag if the cdpActionType is CREATE_TAG. Returns ContactTag if the cdpActionType is DELETE_TAG.

Request Body REQUIRED
askribeKey Askribe Key REQUIRED

Obtain the API key required to connect with Askribe servers from the Settings section in your Askribe flow dashboard.

cdpId CDP Id REQUIRED

This can be acquired from the Contacts dashboard

cdpActionType Type of CDP Action REQUIRED

Possible values: [FIND_CONTACT, FILTER_CONTACTS, FIND_AND_SET_CONTACT, CREATE_CONTACT, UPDATE_CONTACT, DELETE_CONTACT, ADD_TAGS_TO_CONTACT, REMOVE_TAGS_FROM_CONTACT, CREATE_TAG, DELETE_TAG]

findMap object

Required when cdpActionType is FIND_CONTACT or getContactsMechanism is FIND_BY_IDENTIFIER. Used to find a contact with an identifier key-value pair.

filterCondition Filter condition

Required when cdpActionType is FILTER_CONTACTS or getContactsMechanism is FILTER_CONDITION. Used to find all the contacts that match a condition.

contactData object

Required when cdpActionType is one of UPDATE_CONTACT || CREATE_CONTACT. Contains the data for the new or updated contact

tagNames Names of tags[]

Required when cdpActionType is one of ADD_TAGS_TO_CONTACT || REMOVE_TAGS_FROM_CONTACT || CREATE_TAG || DELETE_TAG. Contains the list of tag names

conflictResolutionType How to handle if conflicting data is received

Possible values: [OLD_DATA_WINS, NEW_DATA_WINS, MERGE_WITH_OLD_DATA_WINS, MERGE_WITH_NEW_DATA_WINS]

To be sent optionally when the cdpActionType = CREATE_CONTACT

getContactsMechanism Mechanism to get contacts

Possible values: [FIND_BY_IDENTIFIER, FILTER_CONDITION, CONTACT_ID]

Required if cdpActionType is one of UPDATE_CONTACT || DELETE_CONTACT || ADD_TAGS_TO_CONTACT || REMOVE_TAGS_FROM_CONTACT

contactIds Contact Ids[]

Required when getContactsMechanism is CONTACT_ID. Used to find all the contacts by their ids.

Responses
200

Successfully triggered

Schema OPTIONAL
undefined