{"id":19640140,"url":"https://github.com/gearplug/activecampaign-python","last_synced_at":"2025-04-28T11:31:03.309Z","repository":{"id":53910610,"uuid":"110257368","full_name":"GearPlug/activecampaign-python","owner":"GearPlug","description":"ActiveCampaign API wrapper written in python.","archived":false,"fork":false,"pushed_at":"2024-03-06T13:53:15.000Z","size":78,"stargazers_count":33,"open_issues_count":8,"forks_count":29,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-05T08:25:45.775Z","etag":null,"topics":["active","activecampaign","api","api-wrapper","campaign","python","wrapper","wrapper-api"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GearPlug.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-10T14:42:44.000Z","updated_at":"2025-04-04T16:51:54.000Z","dependencies_parsed_at":"2024-06-18T23:59:22.283Z","dependency_job_id":"7e7cc21a-22af-4238-bbf6-dba5687553f1","html_url":"https://github.com/GearPlug/activecampaign-python","commit_stats":{"total_commits":70,"total_committers":10,"mean_commits":7.0,"dds":0.7428571428571429,"last_synced_commit":"ff1b59ab2ab5c9c0ea8601d61b493eebf5abfb21"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Factivecampaign-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Factivecampaign-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Factivecampaign-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Factivecampaign-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GearPlug","download_url":"https://codeload.github.com/GearPlug/activecampaign-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251304782,"owners_count":21567936,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["active","activecampaign","api","api-wrapper","campaign","python","wrapper","wrapper-api"],"created_at":"2024-11-11T14:04:47.593Z","updated_at":"2025-04-28T11:31:02.473Z","avatar_url":"https://github.com/GearPlug.png","language":"Python","readme":"# activecampaign-python\nActiveCampaign API wrapper written in python.\n\nThis library supports the latest API version 3. If you are looking for API version 1 which is also supported by ActiveCampaign then check below.\n\n## Installing (API v3)\n\n```\npip install activecampaign-python\n```\n\n## Requirements\n\n```\n- requests\n```\n\n## Usage\n\n#### Client instantiation\n```\nfrom activecampaign.client import Client\nclient = Client(URL, API_KEY)\n```\n\n### Automations\n#### List all automations\n```\nresponse = client.automations.list_all_automations()\n```\n\n### Contacts\n#### Create a contact\n```\ndata = {\n\t\"contact\": {\n\t\t\"email\": \"johndoe@example.com\",\n\t\t\"firstName\": \"John\",\n\t\t\"lastName\": \"Doe\",\n\t\t\"phone\": \"7223224241\"\n\t}\n}\nresponse = client.contacts.create_a_contact(data)\n```\n\n#### Create or update contact\n```\ndata = {\n\t\"contact\": {\n\t\t\"email\": \"johndoe@example.com\",\n\t\t\"firstName\": \"John\",\n\t\t\"lastName\": \"Doe\",\n\t\t\"phone\": \"7223224241\"\n\t}\n}\nresponse = client.contacts.create_or_update_contact(data)\n```\n\n#### Retrieve a contact\n```\nresponse = client.contacts.retrieve_a_contact(\"contact_id\")\n```\n\n#### Update list status for a contact\n```\ndata = {\n    \"contactList\": {\n        \"list\": 2,\n        \"contact\": 1,\n        \"status\": 1\n    }\n}\nresponse = client.contacts.update_list_status_for_a_contact(data)\n```\n\n#### Update a contact\n```\ndata = {\n\t\"contact\": {\n\t\t\"email\": \"johndoe@example.com\",\n\t\t\"firstName\": \"John\",\n\t\t\"lastName\": \"Doe\"\n\t}\n}\nresponse = client.contacts.update_a_contact(\"contact_id\", data)\n```\n\n#### Delete a contact\n```\nresponse = client.contacts.delete_a_contact(\"contact_id\")\n```\n\n#### List all contacts\n```\nresponse = client.contacts.list_all_contacts()\n\nAdditionally, you can filter a contact:\nresponse = client.contacts.list_all_contacts(email=\"johndoe@example.com\")\n\nFor more query params: https://developers.activecampaign.com/reference#list-all-contacts\n```\n\n#### List all automations the contact is in\n```\nresponse = client.contacts.list_all_automations_the_contacts_is_in(\"contact_id\")\n```\n\n#### Retrieve a contacts score value\n```\nresponse = client.contacts.retrieve_a_contacts_score_value(\"contact_id\")\n```\n\n#### Add a contact to an automation\n```\ndata = {\n    \"contactAutomation\": {\n        \"contact\": 1,\n        \"automation\": 1\n    }\n}\nresponse = client.contacts.add_a_contact_to_an_automation(data)\n```\n\n#### Retrieve an automation a contact is in\n```\nresponse = client.contacts.retrieve_an_automation_a_contact_is_in(\"contact_automation_id\")\n```\n\n#### Remove a contact from an automation\n```\nresponse = client.contacts.remove_a_contact_from_an_automation(\"contact_automation_id\")\n```\n\n#### List all automations a contact is in\n```\nresponse = client.contacts.list_all_automations_a_contact_is_in()\n```\n\n#### Create a custom field\n```\ndata = {\n\t\"field\": {\n\t\t\"type\": \"textarea\",\n\t\t\"title\": \"Field Title\",\n\t\t\"descript\": \"Field description\",\n\t\t\"isrequired\": 1,\n\t\t\"perstag\": \"Personalized Tag\",\n\t\t\"defval\": \"Defaut Value\",\n\t\t\"visible\": 1,\n\t\t\"ordernum\": 1\n    }\n}\nresponse = client.contacts.create_a_custom_field(data)\n```\n\n#### Retrieve a custom field\n```\nresponse = client.contacts.retrieve_a_custom_field(\"field_id\")\n```\n\n#### Update a custom field\n```\ndata = {\n\t\"field\": {\n\t\t\"type\": \"textarea\",\n\t\t\"title\": \"Field Title\",\n\t\t\"descript\": \"Field description\",\n\t\t\"isrequired\": 1,\n\t\t\"perstag\": \"Personalized Tag\",\n\t\t\"defval\": \"Defaut Value\",\n\t\t\"visible\": 1,\n\t\t\"ordernum\": 1\n    }\n}\nresponse = client.contacts.create_a_custom_field(\"field_id\", data)\n```\n\n#### Delete a custom field\n```\nresponse = client.contacts.delete_a_custom_field(\"field_id\")\n```\n\n#### List all custom fields\n```\nresponse = client.contacts.list_all_custom_fields()\n```\n\n#### Create a custom field relationship to list(s)\n```\ndata = {\n\t\"fieldRel\": {\n\t\t\"field\": 8,\n\t\t\"relid\": 2\n\t}\n}\nresponse = client.contacts.create_a_custom_field_relationship_to_list(data)\n```\n\n#### Create custom field options\n```\ndata = {\n    \"field\": 1,\n    \"label\": \"my custom label\",\n    \"value\": 1,\n    \"orderid\": 1,\n    \"isdefault\": True\n}\nresponse = client.contacts.create_custom_field_options(data)\n```\n\n#### Retrieve field options\n```\nresponse = client.contacts.retrieve_field_options(\"field_id\")\n```\n\n#### Create a custom field value\n```\nresponse = activecampaign_client.contacts.create_a_custom_field_value(data)\n```\n\n#### Retrieve a custom field value\n```\nresponse = activecampaign_client.contacts.retrieve_a_custom_field_value(field_value_id=\"some-id\")\n```\n\n#### Update a custom field value for contact\n```\nresponse = activecampaign_client.contacts.update_a_custom_field_value_for_contact(data, field_value_id=\"some-id\")\n```\n\n#### Delete a custom field value\n```\nresponse = activecampaign_client.contacts.delete_a_custom_field_value(field_value_id=\"some-id\")\n```\n\n#### List all custom field values\n```\nresponse = activecampaign_client.contacts.list_all_custom_field_values()\n```\n\n#### Retrieve a contact's field values\n```\nresponse = activecampaign_client.contacts.retrieve_a_contacts_field_values(contact_id=\"some-id\")\n```\n\n#### Retrieve a contact's tracking logs\n```\nresponse = activecampaign_client.contacts.retrieve_a_contacts_tracking_logs(contact_id=\"some-id\")\n```\n\n#### Retrieve a contact's data\n```\nresponse = activecampaign_client.contacts.retrieve_a_contacts_data(contact_id=\"some-id\")\n```\n\n#### Retrieve a contact's bounce logs\n```\nresponse = activecampaign_client.contacts.retrieve_a_contacts_bounce_logs(contact_id=\"some-id\")\n```\n\n#### Retrieve a contact's geo ips\n```\nresponse = activecampaign_client.contacts.retrieve_a_contacts_geo_ips(contact_id=\"some-id\")\n```\n\n#### Retrieve a contact's organization\n```\nresponse = activecampaign_client.contacts.retrieve_a_contacts_organization(contact_id=\"some-id\")\n```\n\n#### Retrieve a contact's account contacts\n```\nresponse = activecampaign_client.contacts.retrieve_a_contacts_account_contacts(contact_id=\"some-id\")\n```\n\n#### Retrieve a contact's automation entry counts\n```\nresponse = activecampaign_client.contacts.retrieve_a_contacts_automation_entry_counts(contact_id=\"some-id\")\n```\n\n#### Add a tag to a contact\n```\ndata = {\n    \"contactTag\": {\n        \"contact\": \"1\",\n        \"tag\": \"20\"\n    }\n}\nresponse = client.contacts.add_a_tag_to_contact(data)\n```\n\n#### Remove a tag from a contact\n```\nresponse = client.contacts.remove_a_tag_from_a_contact(\"contact_tag_id\")\n```\n\n#### Retrieve contact tags\n```\nresponse = client.contacts.retrieve_contact_tags(\"contact_id\")\n```\n\n### Deals\n#### Create a deal\n```\ndata = {\n  \"deal\": {\n    \"contact\": \"51\",\n    \"description\": \"This deal is an important deal\",\n    \"currency\": \"usd\",\n    \"group\": \"1\",\n    \"owner\": \"1\",\n    \"percent\": None,\n    \"stage\": \"1\",\n    \"status\": 0,\n    \"title\": \"AC Deal\",\n    \"value\": 45600\n  }\n}\nresponse = client.deals.create_a_deal(data)\n```\n\n#### Retrieve a deal\n```\nresponse = client.deals.retrieve_a_deal(\"deal_id\")\n```\n\n#### Update a deal\n```\ndata = {\n  \"deal\": {\n    \"contact\": \"51\",\n    \"description\": \"This deal is an important deal\",\n    \"currency\": \"usd\",\n    \"group\": \"1\",\n    \"owner\": \"1\",\n    \"percent\": None,\n    \"stage\": \"1\",\n    \"status\": 0,\n    \"title\": \"AC Deal\",\n    \"value\": 45600\n  }\n}\nresponse = client.deals.update_a_deal(data)\n```\n\n#### Delete a deal\n```\nresponse = client.deals.delete_a_deal(\"deal_id\")\n```\n\n#### List all deals\n```\nresponse = client.deals.list_all_deals()\n\nAdditionally, you can filter a deal:\nquery = {\n    \"filters[stage]\": 1\n}\nresponse = client.deals.list_all_deals(**query)\n\nFor more query params: https://developers.activecampaign.com/reference#list-all-deals\n```\n\n#### Create a deal note\n```\ndata = {\n  \"note\": {\n    \"note\": \"Note for the deal\"\n  }\n}\nresponse = client.deals.create_a_deal_note(\"deal_id\", data)\n```\n\n#### Update a deal note\n```\ndata = {\n  \"note\": {\n    \"note\": \"Update with more info\"\n  }\n}\nresponse = client.deals.update_a_deal_note(\"deal_id\", \"note_id\", data)\n```\n\n#### List all pipelines\n```\nresponse = client.deals.list_all_pipelines()\n\nAdditionally, you can filter a pipeline:\nquery = {\n    \"filters[title]\": \"My pipeline\"\n}\nresponse = client.deals.list_all_pipelines(**query)\n\nFor more query params: https://developers.activecampaign.com/reference#list-all-pipelines\n```\n\n#### List all stages\n```\nresponse = client.deals.list_all_stages()\n\nAdditionally, you can filter a stage:\nquery = {\n    \"filters[d_groupid]\": 1\n}\nresponse = client.deals.list_all_stages(**query)\n\nFor more query params: https://developers.activecampaign.com/reference#list-all-deal-stages\n```\n\n### Lists\n#### Create a list\n```\ndata = {\n\t\"list\": {\n\t\t\"name\": \"Name of List\",\n\t\t\"stringid\": \"Name-of-list\",\n\t\t\"sender_url\": \"http://activecampaign.com\",\n\t\t\"sender_reminder\": \"You are receiving this email as you subscribed to a newsletter when making an order on our site.\",\n\t\t\"send_last_broadcast\": 0,\n\t\t\"carboncopy\": \"\",\n\t\t\"subscription_notify\": \"\",\n\t\t\"unsubscription_notify\": \"\",\n\t\t\"user\": 1\n\t}\n}\nresponse = client.lists.create_a_list(data)\n```\n\n#### Retrieve a list\n```\nresponse = client.lists.retrieve_a_list(\"list_id\")\n```\n\n#### Delete a list\n```\nresponse = client.lists.delete_a_list(\"list_id\")\n```\n\n#### Retrieve all lists\n```\nresponse = client.lists.retrieve_all_lists()\n```\n\n#### Create a list group permission\n```\ndata = {\n\t\"listGroup\": {\n\t\t\"listid\": 19,\n\t\t\"groupid\": 1\n\t}\n}\nresponse = client.lists.create_a_list_group_permission(data)\n```\n\n### Notes\n#### Create a note\n```\ndata = {\n\t\"note\": {\n\t\t\"note\": \"This is the text of the note\",\n\t\t\"relid\": 2,\n\t\t\"reltype\": \"Subscriber\"\n\t}\n}\nresponse = client.notes.create_a_note(data)\n```\n\n#### Retrieve a note\n```\nresponse = client.notes.retrieve_a_note(\"note_id\")\n```\n\n#### Update a note\n```\ndata = {\n\t\"note\": {\n\t\t\"note\": \"This is the text of the note\",\n\t\t\"relid\": 2,\n\t\t\"reltype\": \"Subscriber\"\n\t}\n}\nresponse = client.notes.update_a_note(\"note_id\", data)\n```\n\n#### Delete a note\n```\nresponse = client.notes.delete_a_note(\"note_id\")\n```\n\n### Tasks\n#### Create a task\n```\ndata = {\n  \"dealTask\": {\n    \"title\":null,\n    \"ownerType\":\"contact\",\n    \"relid\":\"7\",\n    \"status\":0,\n    \"note\":\"Testing Task\",\n    \"duedate\":\"2017-02-25T12:00:00-06:00\",\n    \"edate\":\"2017-02-25T12:15:00-06:00\",\n    \"dealTasktype\":\"1\"\n  }\n}\nresponse = client.tasks.create_a_task(data)\n```\n\n#### Retrieve a task\n```\nresponse = client.tasks.retrieve_a_task(\"task_id\")\n```\n\n#### Update a task\n```\ndata = {\n  \"dealTask\": {\n    \"title\":null,\n    \"ownerType\":\"contact\",\n    \"relid\":\"7\",\n    \"status\":0,\n    \"note\":\"Testing Task\",\n    \"duedate\":\"2017-02-25T12:00:00-06:00\",\n    \"edate\":\"2017-02-25T12:15:00-06:00\",\n    \"dealTasktype\":\"1\"\n  }\n}\nresponse = client.tasks.update_a_task(\"task_id\", data)\n```\n\n#### Delete a task\n```\nresponse = client.tasks.delete_a_task(\"task_id\")\n```\n\n#### List all tasks\n```\nresponse = client.tasks.list_all_tasks()\n\nAdditionally, you can filter a task:\nquery = {\n    \"filters[title]\": \"My task\"\n}\nresponse = client.deals.list_all_tasks(**query)\n\nFor more query params: https://developers.activecampaign.com/reference#list-all-tasks\n```\n\n### Users\n#### Create a user\n```\nresponse = client.users.create_a_user(data)\n```\n\n#### Retrieve a user\n```\nresponse = client.users.retrieve_a_user(\"user_id\")\n```\n\n#### Retrieve a user by email\n```\nresponse = client.users.retrieve_a_user_by_email(\"email\")\n```\n\n#### Retrieve a user by username\n```\nresponse = client.users.retrieve_a_user_by_username(\"username\")\n```\n\n#### Retrieve logged-in user\n```\nresponse = client.users.retrieve_logged_in_user()\n```\n\n#### Update a user\n```\nresponse = client.users.update_a_user(\"user_id\", data)\n```\n\n#### Delete a user\n```\nresponse = client.users.delete_a_user(\"user_id\")\n```\n\n#### List all users\n```\nresponse = client.users.list_all_users()\n```\n\n### Webhooks\n#### Create a webhook\n```\ndata = {\n    \"webhook\": {\n        \"name\": \"My Hook\",\n        \"url\": \"http://example.com/my-hook\",\n        \"events\": [\n            \"subscribe\",\n            \"unsubscribe\",\n            \"sent\"\n        ],\n        \"sources\": [\n            \"public\",\n            \"system\"\n        ]\n    }\n}\nresponse = client.webhooks.create_a_webhook(data)\n```\n\n#### Retrieve a webhook\n```\nresponse = client.webhooks.retrieve_a_webhook(\"webhook_id\")\n```\n\n#### Delete a webhook\n```\nresponse = client.webhooks.delete_a_webhook(\"webhook_id\")\n```\n\n#### List all webhooks\n```\nresponse = client.webhooks.list_all_webhooks()\n\nAdditionally, you can filter a webhook:\nquery = {\n    \"filters[name]\": \"My webhook\"\n}\nresponse = client.deals.list_all_webhooks(**query)\n\nFor more query params: https://developers.activecampaign.com/reference#get-a-list-of-webhooks\n```\n\n#### List all webhook events\n```\nresponse = client.webhooks.list_all_webhook_events()\n```\n\n### Tags\n#### Create a tag\n```\ndata = {\n    \"tag\":{\n        \"tag\": \"My Tag\",\n        \"tagType\": \"contact\",\n        \"description\": \"Description\"\n    }\n}\nresponse = client.tags.create_a_tag(data)\n```\n\n#### Retrieve a tag\n```\nresponse = client.tags.retrieve_a_tag(\"tag_id\")\n```\n\n#### Update a tag\n```\ndata = {\n    \"tag\":{\n        \"tag\": \"My Tag\",\n        \"tagType\": \"contact\",\n        \"description\": \"Description\"\n    }\n}\nresponse = client.tags.update_a_tag(\"tag_id\", data)\n```\n\n#### Delete a tag\n```\nresponse = client.tags.delete_a_tag(\"tag_id\")\n```\n\n#### List all tags\n```\nresponse = client.tags.list_all_tags(search='Tag Name')\n```\n\n### Custom Objects\n#### Create a schema\n```\ndata = {\n  \"schema\": {\n    \"slug\": \"object-name\",\n    \"labels\": {\n      \"singular\": \"ObjectName\",\n      \"plural\": \"ObjectNames\"\n    },\n    \"description\": \"Some Description\",\n    \"fields\": [\n      {\n        \"id\": \"some-field-id\",\n        \"labels\": {\n          \"singular\": \"ID\",\n          \"plural\": \"IDs\"\n        },\n        \"type\": \"text\",\n        \"required\": True,\n      },\n    ],\n    \"relationships\": [\n      {\n        \"id\": \"primary-contact\",\n        \"labels\": {\n          \"singular\": \"Primary Contact\",\n          \"plural\": \"Primary Contacts\"\n        },\n        \"description\": \"Primary contact to this object\",\n        \"namespace\": \"contacts\",\n        \"hasMany\": False\n      }\n    ]\n  }\n}\nresponse = client.customobjects.create_a_schema(data=data)\n```\n\n#### Retrieve a schema\n```\nresponse = client.customobjects.retrieve_a_schema(schema_id=\"some-id\", show_all_fields=False)\n```\n\n#### Update a schema\n```\ndata = {\n  \"schema\": {\n    \"slug\": \"object-name\",\n    \"labels\": {\n      \"singular\": \"ObjectName\",\n      \"plural\": \"ObjectNames\"\n    },\n    \"description\": \"Some Description\",\n    \"fields\": [\n      {\n        \"id\": \"some-field-id\",\n        \"labels\": {\n          \"singular\": \"ID\",\n          \"plural\": \"IDs\"\n        },\n        \"type\": \"text\",\n        \"required\": True,\n      },\n      {\n        \"id\": \"some-other-field-id\",\n        \"labels\": {\n          \"singular\": \"OtherID\",\n          \"plural\": \"OtherIDs\"\n        },\n        \"type\": \"text\",\n        \"required\": True,\n      },\n    ],\n    \"relationships\": [\n      {\n        \"id\": \"primary-contact\",\n        \"labels\": {\n          \"singular\": \"Primary Contact\",\n          \"plural\": \"Primary Contacts\"\n        },\n        \"description\": \"Primary contact to this object\",\n        \"namespace\": \"contacts\",\n        \"hasMany\": False\n      }\n    ]\n  }\n}\nresponse = client.customobjects.update_a_schema(schema_id=\"some-schema-id\", data=data, show_all_fields=False)\n```\n\n#### Delete a schema\n```\nresponse = client.customobjects.delete_a_schema(schema_id=\"some-id\")\n```\nWARNING: This deletes all associated records\n\n#### List all schemas\n```\nresponse = client.customobjects.list_all_schemas(schema_relationship=\"contact\", limit=20, offset=0, ordering=None, show_all_fields=False)\n```\n\n#### Delete field in schema\n```\nresponse = client.customobjects.delete_a_field(schema_id=\"some-id\", field_id=\"some-field-id\", show_all_fields=False)\n```\n\n#### Create a public schema\n```\ndata = {\n\n}\nresponse = client.customobjects.create_a_public_schema(data=data)\n```\n\n#### Create a child schema\n```\nresponse = client.customobjects.create_a_child_schema(parent_id=\"some-parent-schema-id\")\n```\n\n#### Upsert custom object record\n```\ndata = {\n  \"record\": {\n    \"fields\": [\n      {\n        \"id\": \"some-field-id\",\n        \"value\": \"asdf-1234\"\n      },\n      {\n        \"id\": \"some-other-field-id\",\n        \"value\": \"asdf-5678\"\n      },\n    ]\n  }\n}\nresponse = client.customobjects.create_or_update_record(schema_id=\"some-id\", data=data)\n```\n\n#### Retrieve a record\n```\nresponse = client.customobjects.retrieve_a_record(schema_id=\"some-id\", record_id=\"some-record-id\")\n```\n\n#### Retrieve a record by external id\n```\nresponse = client.customobjects.retrieve_a_record_by_external_id(schema_id=\"some-id\", external_id=\"some-record-id\")\n```\n\n#### Delete a record\n```\nresponse = client.customobjects.delete_a_record(schema_id=\"some-id\", record_id=\"some-record-id\")\n```\n\n#### Delete a record by external id\n```\nresponse = client.customobjects.delete_a_record_by_external_id(schema_id=\"some-id\", external_id=\"some-record-id\")\n```\n\n#### List all records\n```\nresponse = client.customobjects.list_all_records(\n        schema_id=\"some-id\", contact_id=\"some-contact-id\", deal_id=None, account_id=None,\n        limit=20, offset=0)\n```\n\n### Addresses\n#### Create an address\n```\nresponse = activecampaign_client.addresses.create_an_address(data)\n```\n\n#### Retrieve an address\n```\nresponse = activecampaign_client.addresses.retrieve_address(address_id=\"some-id\")\n```\n\n#### Update an address\n```\nresponse = activecampaign_client.addresses.update_address(data, address_id=\"some-id\")\n```\n\n#### Delete an address\n```\nresponse = activecampaign_client.addresses.delete_address(address_id=\"some-id\")\n```\n\n#### Delete an address associated with a user group\n```\nresponse = activecampaign_client.addresses.delete_address_associated_with_user_group(group_id=\"some-id\")\n```\n\n#### Delete an address associated with a list\n```\nresponse = activecampaign_client.addresses.delete_address_associated_with_list(list_id=\"some-id\")\n```\n\n#### Retrieve all addresses\n```\nresponse = activecampaign_client.addresses.retrieve_all_addresses()\n```\n\n### Campaigns\n#### List all campaigns\n```\nresponse = activecampaign_client.campaigns.list_all_campaigns()\n```\n\n#### Retrieve a link associated campaign\n```\nresponse = activecampaign_client.campaigns.retrieve_a_link_associated_campaign(campaign_id=\"some-id\")\n```\n\n#### Retrieve a campaign\n```\nresponse = activecampaign_client.campaigns.retrieve_a_campaign(campaign_id=\"some-id\")\n```\n\n### Brandings\n#### Retrieve a branding\n```\nresponse = activecampaign_client.brandings.retrieve_a_branding(branding_id=\"some-id\")\n```\n\n#### Update a branding\n```\nresponse = activecampaign_client.brandings.update_a_branding(data, branding_id=\"some-id\")\n```\n\n#### List all brandings\n```\nresponse = activecampaign_client.brandings.list_all_brandings()\n```\n\n## About API v1\n\nYou can clone and checkout our tag v0.1.1.\n\n```\n$ git clone https://github.com/GearPlug/activecampaign-python.git\n$ git checkout tags/v0.1.1 -b \u003cbranch_name\u003e\n```\n\nAlso you can install this version in pip\n```\n$ pip install activecampaign-python=0.1.1\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgearplug%2Factivecampaign-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgearplug%2Factivecampaign-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgearplug%2Factivecampaign-python/lists"}