Statflo Documentation
Campaign Members
Campaign Members
Campaign Membersshow up in TextKit as people To Be Contacted by an authenticated User, and are the required method for a User to initiate a new conversation.
createCampaignMember
To create a new Campaign Member, use this query:
# locale: preferred language of the Campaign Member# method: form of communication to be used# from: sender's id to show the recipient# to: where recipient will receive communication# freeFormColumns: used by Wigets or Templates## When the method is SMS, `from` is the number to send messages from and `to` is the number to receive the message. # Phone numbers must be in E.164 format. # firstName, from, to and locale are requiredmutation { createCampaignMember(input: { firstName: "Hans" lastName: "Gruber" from: "+15551112323" to: "+14443336666" method: SMS assignedUserId: "af73ed10-01ff-4b96-8444-079ff8fdda57" contactExternalId: "0033000000GvHjL" campaignExternalId: "70190000000Yz7O" locale: "EN_US" state: INACTIVE freeFormColumns: [ { name: "NICKNAME", value: "Hansio" }, { name: "PRODUCT", value: "$1K Saver Loan" }, { name: "REP", value: "Sara" } ] }) { userErrors { field message } }}Which responds with, on success:
{ "data": { "createCampaignMember": "dbee7e46-a486-4d8c-b494-5adf04d5cab3" }}updateCampaignMember
To update a campaign member, use this query:
mutation { updateCampaignMember(input: { id: "dbee7e46-a486-4d8c-b494-5adf04d5cab3" to: "+14443336666" locale: "ES_US" state: ACTIVE assignedUserId: "db7fa5d7-1524-45b2-8f43-0bf555b80207" }) { userErrors { field message } }}Which responds with, on success:
{ "data": { "updateCampaignMember": true}deleteCampaignMember
Deleting is not reversable.
mutation { deleteCampaignMember(input: { "id": "dbee7e46-a486-4d8c-b494-5adf04d5cab3" })}Which responds with, on success:
{ "data": { "deleteCampaignMember": true }}locales
enum locales { AF_ZA AM_ET AR_AE AR_BH AR_DZ AR_EG AR_IQ AR_JO AR_KW AR_LB AR_LY AR_MA ARN_CL AR_OM AR_QA AR_SA AR_SY AR_TN AR_YE AS_IN AZ_CYRL_AZ AZ_LATN_AZ BA_RU BE_BY BG_BG BN_BD BN_IN BO_CN BR_FR BS_CYRL_BA BS_LATN_BA CA_ES CO_FR CS_CZ CY_GB DA_DK DE_AT DE_CH DE_DE DE_LI DE_LU DSB_DE DV_MV EL_GR EN_029 EN_AU EN_BZ EN_CA EN_GB EN_IE EN_IN EN_JM EN_MY EN_NZ EN_PH EN_SG EN_TT EN_US EN_ZA EN_ZW ES_AR ES_BO ES_CL ES_CO ES_CR ES_DO ES_EC ES_ES ES_GT ES_HN ES_MX ES_NI ES_PA ES_PE ES_PR ES_PY ES_SV ES_US ES_UY ES_VE ET_EE EU_ES FA_IR FI_FI FIL_PH FO_FO FR_BE FR_CA FR_CH FR_FR FR_LU FR_MC FY_NL GA_IE GD_GB GL_ES GSW_FR GU_IN HA_LATN_NG HE_IL HI_IN HR_BA HR_HR HSB_DE HU_HU HY_AM ID_ID IG_NG II_CN IS_IS IT_CH IT_IT IU_CANS_CA IU_LATN_CA JA_JP KA_GE KK_KZ KL_GL KM_KH KN_IN KOK_IN KO_KR KY_KG LB_LU LO_LA LT_LT LV_LV MI_NZ MK_MK ML_IN MN_MN MN_MONG_CN MOH_CA MR_IN MS_BN MS_MY MT_MT NB_NO NE_NP NL_BE NL_NL NN_NO NSO_ZA OC_FR OR_IN PA_IN PL_PL PRS_AF PS_AF PT_BR PT_PT QUT_GT QUZ_BO QUZ_EC QUZ_PE RM_CH RO_RO RU_RU RW_RW SAH_RU SA_IN SE_FI SE_NO SE_SE SI_LK SK_SK SL_SI SMA_NO SMA_SE SMJ_NO SMJ_SE SMN_FI SMS_FI SQ_AL SR_CYRL_BA SR_CYRL_CS SR_CYRL_ME SR_CYRL_RS SR_LATN_BA SR_LATN_CS SR_LATN_ME SR_LATN_RS SV_FI SV_SE SW_KE SYR_SY TA_IN TE_IN TG_CYRL_TJ TH_TH TK_TM TN_ZA TR_TR TT_RU TZM_LATN_DZ UG_CN UK_UA UR_PK UZ_CYRL_UZ UZ_LATN_UZ VI_VN WO_SN XH_ZA YO_NG ZH_CN ZH_HK ZH_MO ZH_SG ZH_TW ZU_ZA}methods
enum method { SMS WHATSAPP WEBCHAT INAPP CALL RCS APPLEMESSAGE GOOGLEMESSAGE EMAIL WECHAT FACEBOOK RCS LINE VIBER VIDEO TWITTER}