JUMP TOGetting StartedOverviewAuthenticationBase URLChange LogErrorsHTTP MethodsPagination, Ordering, and FilteringRate LimitsSchemaSide LoadingTipsRequests and FeedbackAPI GuidesContact Custom Objects API GuideContact Custom Fields API GuideContact Event Tracking API GuideAccountsAccountsCreate an accountpostUpdate an accountputRetrieve an accountgetDelete an accountdeleteList all accountsgetCreate an account notepostUpdate an account noteputBulk delete accountsdeleteAccount Contact AssociationCreate an associationpostRetrieve an associationgetUpdate an associationputDelete an associationdeleteList all associationsgetCustom Account FieldsCreate a custom fieldpostRetrieve a custom fieldgetUpdate a custom fieldputDelete a custom fielddeleteList all custom fieldsgetCustom Account Field ValuesCreate a custom field valuepostBulk create a custom account field valuepostRetrieve a custom field valuegetUpdate a custom field valueputDelete a custom field valuedeleteList all custom field valuesgetBulk update a custom field valuepatchAddressesAddressesCreate an addresspostRetrieve an addressgetUpdate an addressputDelete an addressdeleteDelete address associated with a specific user groupdeleteDelete address associated with a specific listdeleteList all addressesgetAutomationsAutomationsList all automationsgetBrandingBrandingRetrieve a brandinggetUpdate a brandingputList all brandingsgetCalendar FeedsCalendar FeedsCreate a calendar feedpostRetrieve a calendar feedgetUpdate a calendar feedputDelete a calendar feeddeleteList all calendar feedsgetCampaignsCampaignsCreate Shareable Campaign Template LinkgetList all campaignsgetRetrieve links associated to campaigngetRetrieve a campaigngetEdit campaignputCreate CampaignpostDuplicate CampaignpostMessagesCreate a messagepostRetrieve a messagegetUpdate a messageputDelete a messagedeleteList all messagesgetVariablesList VariablesgetRetrieve a VariablegetCreate a VariablepostEdit a VariableputDelete a VariabledeleteBulk Delete VariablesdeleteContactsContactsCreate a contactpostSync a contact's datapostRetrieve a contactgetUpdate list status for a contactpostUpdate a contactputDelete a contactdeleteList, search, and filter contactsgetList all automations the contact is ingetRetrieve a contact's score valuegetBulk import contactspostBulk import status listgetBulk import status infogetList a contact's activitiesgetRetrieve a contact's bounce logsgetRetrieve a contact's datagetRetrieve a contact's goalsgetRetrieve a contact's list membershipsgetRetrieve a contact's logsgetRetrieve a list of contact's dealsgetRetrieve a contact's dealsgetRetrieve a contact's field valuesgetRetrieve a contacts list of geo-ipsgetRetrieve a contacts geo IP addressgetRetrieve a contacts notesgetRetrieve list of all notesgetRetrieve a contacts organizationgetRetrieve a contacts plus appendgetRetrieve a contacts tracking logsgetRetrieve a contacts account contactsgetRetrieve a contacts automation entry countsgetAutomationsAdd a contact to an automationpostRetrieve an automation a contact is ingetRemove a contact from an automationdeleteList all automations a contact is ingetCustom FieldsCreate a custom fieldpostAdd Custom Field to Field GrouppostDelete Custom Field Field GroupdeleteUpdate a custom fieldputRetrieve a custom fieldgetGet Custom Field to Field GroupgetUpdate Custom Field Field GroupputDelete a custom fielddeleteList all custom fieldsgetCreate a custom field relationship to list(s)postCreate custom field optionspostDelete a custom field relationship to list(s)deleteCustom Field ValuesCreate a custom field valuepostRetrieve a custom field valuegetUpdate a custom field value for contactputDelete a custom field valuedeleteList all custom field valuesgetEmail (emailActivities)List all email activitiesgetTagsAdd a tag to contactpostRemove a tag from a contactdeleteCustom ObjectsCustom Object schemasList all schemasgetRetrieve a schemagetCreate a schemapostUpdate a schemaputDelete a schemadeleteDelete a fielddeleteParent and Child SchemasCreate a public schemapostCreate a child schemapostManaging RecordsList records by schemagetCreate or update recordpostGet a record by idgetGet a record by external idgetDelete a record by iddeleteDelete a record by external IDdeletePaging, Ordering, Sorting, and FilteringDealsDealsCreate a dealpostRetrieve a dealgetUpdate a dealputDelete a dealdeleteList all dealsgetCreate a deal notepostUpdate a deal noteputBulk Update Deal OwnerspatchList all deal activitiesgetPipelinesCreate a pipelinepostRetrieve a pipelinegetUpdate a pipelineputDelete a pipelinedeleteList all pipelinesgetStagesCreate a stagepostRetrieve a stagegetUpdate a stageputDelete a stagedeleteList all stagesgetMove deals to another stageputCustom Deal FieldsCreate a custom field metapostRetrieve a custom fieldgetUpdate a custom fieldputDelete a custom fielddeleteList all custom fieldsgetCustom Deal Field ValuesCreate a custom field valuepostBulk create a custom deal field valuepostRetrieve a custom field valuegetUpdate a custom field valueputBulk update a custom field valuepatchDelete a custom field valuedeleteList all custom field valuesgetSecondary ContactsCreate a secondary contactpostRetrieve a secondary contactgetUpdate a secondary contactputDelete a secondary contactdeleteList all secondary contactsgetDeal RolesList all deal rolesgetCreate a deal rolepostDelete a deal roledeleteDeepData IntegrationsConnectionsCreate a connectionpostRetrieve a connectiongetUpdate a connectionputDelete a connectiondeleteList all connectionsgetE-Commerce CustomersCreate a customerpostRetrieve a customergetUpdate a customerputDelete a customerdeleteList all customersgetE-Commerce OrdersCreate an orderpostRetrieve an ordergetUpdate an orderputDelete an orderdeleteList all ordersgetE-Commerce Abandoned CartsE-Commerce Order ProductsList EcomOrderProductsgetList EcomOrderProducts for a Specific EcomOrdergetRetrieve an EcomOrderProductgetEcomMerce graphQl apiOverviewAbout the GraphQL APIReferenceSearchesOrdersRecurring PaymentsShared ObjectsFormsFormsRetrieve a formgetList all formsgetListsListsCreate a listpostRetrieve a listgetDelete a listdeleteRetrieve all listsgetCreate a list group permissionpostNotesNotesCreate a notepostRetrieve a notegetUpdate a noteputDelete a notedeleteSaved ResponsesSaved ResponsesCreate a saved responsepostRetrieve a saved responsegetUpdate a saved responseputDelete a saved responsedeleteList all saved responsesgetScoresScoresRetrieve a scoregetList all scoresgetSegmentsSegmentsRetrieve a segmentgetList all segmentsgetSettingsSettingsUpdate settingsputSite & Event TrackingEvent TrackingTrack eventpostCreate a new event (name only)postRetrieve Event Tracking StatusgetEnable/disableputDelete event (name only)deleteList all events (names only)getGet Contact's Tracking Logs/EventsgetGet Contact By Event IDgetSite TrackingAdd domain to whitelistpostRetrieve site tracking codegetRetrieve statusgetEnable/disableputRemove domain from whitelistdeleteList all whitelisted domainsgetTagsTagsCreate a tagpostRetrieve a taggetUpdate a tagputDelete a TagdeleteList all tagsgetTasksTasksCreate a taskpostRetrieve a taskgetUpdate a taskputDelete a taskdeleteList all tasksgetTask OutcomesTask OutcomesCreate a task outcomepostRetrieve a task outcomegetUpdate a task outcomeputDelete a task outcomedeleteList all task outcomesgetTask TypesTask TypesCreate a task typepostRetrieve a task typegetUpdate a task typeputDelete a task typedeleteList all task typesgetMove tasks to another task typeputTask Types and Outcomes RelationsTask Types and Outcomes RelationsRetrieve a task type - outcome relationgetDelete a task type - outcome relationdeleteList all task type - outcome relationsgetTask Reminders/NotificationsTask Reminders/NotificationsCreate a task reminderpostTemplatesTemplatesRetrieve a templategetUsersUsersCreate a userpostRetrieve a usergetRetrieve a user by emailgetRetrieve a user by usernamegetRetrieve logged-in usergetUpdate a userputDelete a userdeleteList all usersgetGroupsCreate a grouppostRetrieve a groupgetUpdate a groupputDelete a groupdeleteList all groupsgetList All Group LimitsgetWebhooksWebhooksCreate a webhookpostRetrieve a webhookgetUpdate a webhookputDelete a webhookdeleteList all webhooksgetList all webhook eventsgetWebhook PayloadsCampaignsCampaigns are broadcast emails sent out to a list of contacts.Campaign status available values For following parameters: Sending status Use the following values: Status ValueMeaning0Draft1Scheduled2Sending3Paused4Stopped5Completed
