Welcome to the API documentation for CiviClick 2.0! The API enables you to access and manage your CiviClick data programmatically.
\nYou can see that the different endpoint groups encapsulate operations related to key entities: Campaigns, Actions and Advocates. You can browse the related endpoints and functionalities below, under the heading of each entity.
\nValues to be replaced are indicated in double curly brackets like this: {{API_key}}. Replace the actual value without including the curly brackets, so for example if your API key is 1234, \"Bearer {{API_key}}\" would resolve to \"Bearer 1234\".
You must use a valid API Key to send requests to the API endpoints. You can get your API key from the Admin tab in the app under the API access section.
The API Key should be included in the Authorization header in the format
\"Bearer {{your_API_key}}\"
If the API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
\nThe API has no explicit rate or usage limitation; we trust our Customers to use the API responsibly. In case we notice a sudden spike in the volume or frequency of your API calls, our Customer Success Team will reach out to you.
\nAn HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, please contact our Customer Success Team via email or the Get Help button in the app.
The API only responds to HTTPS-secured communications.
\nThe API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
\nYou can get configuration information (key campaign settings including targets) as well as campaign statistics (total actions taken, unique advocates, total target connections made), for one or more campaigns.
\nPlease note that because a campaign can have a large number of targets on it, the list of targets is only returned when you're querying for one campaign specifically.
\nThis endpoint is compatible with v2 campaigns only. (v1 campaign compatibility is on the roadmap.)
\ncampaign_ids:list of integers
active_only is set up.active_only: true/false (boolean), defaults to true
You can retrieve key campaign configuration information, campaign statistics and campaign target information for any of your campaigns in CiviClick.
\n","event":[{"listen":"prerequest","script":{"id":"53faad8e-311d-45bb-9a00-cc24f000da7e","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"d84cd051-5a0e-4ce6-9cf3-b2a6341b74cc","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"54c3edb9-b4c0-480b-b121-62f923e67431","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"You can programmatically post advocate actions by using this endpoint.
\nThis endpoint is only compatible with v2 campaigns.
\ncreated_by: string, optional
campaign_id: integer, REQUIRED
action_type: string, REQUIRED
Email | Video | Tweet | Petition |Regulatoryadvocate_email: string, REQUIRED
country: string, REQUIRED
US | CA | AU | UKadvocate_address: string, REQUIRED
advocate_zip: string, REQUIRED
advocate_prefix: string, required for federal campaigns
Mr. | Mrs. | Miss | Ms. | Dr.advocate_firstname: string, REQUIRED
advocate_lastname: string, REQUIRED
advocate_phone: string, REQUIRED
video_link: string, REQUIRED
Video action.privacy_opt_in: boolean, optional, defaults to true
allow_company_to_contact: boolean, optional, defaults to true
smsOptin: boolean, optional, defaults to true
questions: array of JSON objects, optional
covers any custom questions that the advocate answered
\nif custom questions are used as custom fields in any of the legislator messages, the question objects need to include the id of the custom questions as well, as they are displayed in the email template (without the brackets and the @ symbol; see example below)
\n[\n {\n \"id\": \"custom-1-en\",\n \"Question\": \"What are your favorite areas?\",\n \"Answer\": \"Tax reform, Traffic control\"\n },\n {\n \"id\": \"custom-2-en\"\n \"Question\": \"Why is this initiative important to you?\",\n \"Answer\": \"My grandma has asthma and I worry for her.\"\n },\n]\n\nregulatory_document_id: string, required for Regulatory action
regulatory_subject: string, required for Regulatory action
regulatory_body: string, required for Regulatory action
Email and Video actions)test_submission: boolean, optional, defaults to false
Email and Video actions. Target messages will be sent to the test_email provided, instead of the actual emails of target legislators.test_email: string, required if test_submission is true
test_submission is true.Calls to this endpoint will return actions submitted across all your campaigns since your last query to this endpoint. (Our database will automatically track which actions have already been served to you over this endpoint, and will only return new ones that haven't been served yet.)
\nThe endpoint will return a maximum of 1,000 items in a call. If you'd like to get all of your actions, repeat the call until you get back less than 1,000 items in a call or you get back an empty array.
\nThis endpoint is compatible with v1 and v2 campaigns.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"You can reset the new action tracker to 0 or to an action ID of your choice by using this endpoint.
\nIf set to 0, all actions in our database will be returned on the next query to Get new actions; if set to a non-zero number, all actions submitted after the inputted action ID will be returned on the next query to Get new actions.
\nThis utility endpoint can be extremely useful if you encountered issues ingesting the results of one or more previous Get new actions calls. Otherwise, you probably won't need to leverage this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The ID of the last action you have successfully ingested. The endpoint will return actions submitted after the action with the provided ID. Set to 0 to retrieve all your actions in our systems.
\n","type":"text/plain"},"key":"action_id","value":"0"}],"variable":[]}},"response":[{"id":"63895e59-afce-48db-944a-e885d691d252","name":"Reset new action tracker","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"https://api.civiclick.com/v2/actions/reset_tracker?action_id=0","host":["https://api.civiclick.com/v2"],"path":["actions","reset_tracker"],"query":[{"key":"action_id","value":"0","description":"The ID of the last action you have successfully ingested. The endpoint will return actions submitted after the action with the provided ID. Set to 0 to retrieve all your actions in our systems."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Apr 2025 13:01:25 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"XNS=51214782689b171386ed29636a1f10e7|588d505220a1b82bfd28a6b578c631af; Path=/socket/; Secure; HttpOnly; SameSite=Strict"},{"key":"X-App","value":"hit"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 27 Apr 2015 13:01:25 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, PUT, PATCH, OPTIONS, HEAD"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Trace-ID","value":"1986f62a-630e-40b0-a295-3f13bbdd868a"},{"key":"Content-Encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"}],"cookie":[],"responseTime":null,"body":"\"success\""}],"_postman_id":"661a8949-04b8-42d9-ae4c-44d9bb4e3b34"},{"name":"Subscribe to actions webhook","id":"93634231-3b02-41ff-882d-d0081967eb84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"target_url\": \"https://www.example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.civiclick.com/v2/actions/subscribe","description":"You can subscribe to our actions webhook by sending an API call to this endpoint with the target url you'd like us to send your actions and corresponding advocate data to.
\nIf you already have a subscription, and you send a request to this endpoint, no change will be effectuated, and the API will indicate the target URL your current subscription is set up for. If you'd like to resubscribe with a new target URL, use the DELETE /actions/unsubscribe endpoint first to remove your existing subscription, then resubscribe with the new target URL through this endpoint.
\nHow does the webhook work?
\nWhen an advocate action arrives into our system, if you are subscribed to this webhook, our server will send you the submission's (action's) key data as well as the submitting advocate's key data to the target URL set up in your subscription.
\ntarget_url: string, REQUIRED
You can remove your actions webhook subscription via an API call to this endpoint. No input required; our backend will identify your customer entity based on your API access token and remove the corresponding webhook subscription.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"You can post campaign submissions (advocate actions) programmatically and you can retrieve all advocate actions posted to any of your campaigns.
\n","event":[{"listen":"prerequest","script":{"id":"aeea7389-186e-4ee2-8ed2-01d74c150b55","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"8f680342-ab47-43f6-bc99-72d21653f806","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"ff0bdec6-2f96-4fb6-adb9-2a32b4affd62","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"You can import new advocates you'd like to leverage for campaigns or outreach, into our system via this endpoint.
\nThis endpoint is compatible with CiviClick 1.0 and CiviClick 2.0 as well.
\nemail: string, REQUIRED
prefix: string, optional
Mr. | Mrs. | Miss | Ms. | Dr.first_name: string, REQUIRED
last_name: string, REQUIRED
phone: string, optional
country: string, REQUIRED
US | CA | AU | UKstreet_address_1: string, REQUIRED
zip: string, REQUIRED
city: string, optional
state: string, optional
longitude: decimal, optional
latitude: decimal, optional
Congressional_District: string, optional
State_Senate_District: string, optional
state_house_district: string, optional
privacy_opt_in: boolean, optional, defaults to true
custom_question: array of JSON objects, optional
age_group: string, optional
political_affiliation: string, optional
policy_issue_interests: array of strings, optional
total_count: number, optional
email_count: number, optional
phone_count: number, optional
tweet_count: number, optional
video_count: number, optional
comment_count: number, optional
petition_count: number, optional
last_action_date: date, optional
email_last_action_date: date, optional
phone_last_action_date: date, optional
tweet_last_action_date: date, optional
video_last_action_date: date, optional
comment_last_action: date, optional
petition_last_action_date: date, optional
You can update the information on any advocate you have in our system via this endpoint.
\nFor a description of request body fields, please refer to Add new advocates above. The only difference between the two input signatures is that here you will have to add advocate_id so our system knows which advocate you'd like to update.
Please note that while we provide you the option to update activity metrics on advocates (e.g., total_actions) for practical purposes — i.e., you uploaded an advocate but would like to update their data before they participate in any campaigns —, once you do so, the metrics shown in the app may not reflect reality. Our systems automatically update these metrics, but cannot ensure their accuracy once they have been manually manipulated.
Calls to this endpoint will return new advocates added to our system for your organization since your last query to this endpoint. (Our database will automatically track which advocates have already been served to you over this endpoint, and will only return new ones that haven't been served yet.)
\nThe endpoint will return a maximum of 1,000 items in a call. If you'd like to get all of your new advocates (and you seem to have more than 1,000), repeat the call until you get back less than 1,000 items in a call or you get back an empty array.
\nThis endpoint is compatible with advocate data from v1 and v2 campaigns.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"You can reset the new advocate tracker to 0 or to an advocate ID of your choice by using this endpoint.
\nIf set to 0, all your advocates in our database will be returned on the next query to Get new advocates (in batches as described); if set to a non-zero number, all your advocates created after the provided advocate ID will be returned on the next query to Get new advocates (in batches as described).
\nThis utility endpoint can be extremely useful if you encountered issues ingesting the results of one or more previous Get new advocates calls. Otherwise, you probably won't need to leverage this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The ID of the last advocate you have successfully ingested. The endpoint will return advocates created after the advocate with the provided ID was created. Set to 0 to retrieve all your advocates stored in our systems.
\n","type":"text/plain"},"key":"advocate_id","value":"0"}],"variable":[]}},"response":[{"id":"34c91f82-7d71-45dc-bda5-716ac0630b00","name":"Reset new advocate tracker","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"https://api.civiclick.com/v2/advocates/reset_tracker?advocate_id=10","host":["https://api.civiclick.com/v2"],"path":["advocates","reset_tracker"],"query":[{"key":"advocate_id","value":"10","description":"The ID of the last advocate you have successfully ingested. The endpoint will return advocates created after the advocate with the provided ID was created. Set to 0 to retrieve all your advocates stored in our systems."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Apr 2025 14:21:57 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"XNS=4df334fe62e8200c1f9b542ba909b135|588d505220a1b82bfd28a6b578c631af; Path=/socket/; Secure; HttpOnly; SameSite=Strict"},{"key":"X-App","value":"hit"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 27 Apr 2015 14:21:57 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, PUT, PATCH, OPTIONS, HEAD"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Trace-ID","value":"ac51894f-5325-4510-a447-f71f242b9cb4"},{"key":"Content-Encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"}],"cookie":[],"responseTime":null,"body":"\"success\""}],"_postman_id":"27d059c0-ce12-48c5-83e5-62fa07950dff"}],"id":"d528de7a-bc59-4108-9816-fa2b5822e2ec","description":"You can add and update advocates to your CiviClick Advocate Universe, or retrieve all of your advocates when using the related API endpoints.
\n","event":[{"listen":"prerequest","script":{"id":"0943dc82-fbf8-48f5-8eda-de1c4587d430","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"92ff6c25-b0d8-408b-a02a-d04e77146527","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"d528de7a-bc59-4108-9816-fa2b5822e2ec","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"