| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://campayn.com/api/v1 | link | — | — | — |
Actions (14)
Contacts · 5
- Add contact to listPOST /lists/{list_id}/contacts.json
Create a new contact within the specified list (body may include fields like email, first_name, last_name, etc.).
documented - Filter contacts in a listGET /lists/{list_id}/contacts.json?filter[contact]={keyword}
Return contacts within a list whose names, emails, or companies match the provided keyword.
documented - Get contact by IDGET /contacts/{contact_id}.json
Retrieve details for a single contact by its ID.
documented - List contacts in a listGET /lists/{list_id}/contacts.json
Retrieve contacts that belong to a specific list.
documented - Update contactPUT /contacts/{contact_id}.json
Update details for a specific contact (fields provided in the request body are applied; unspecified fields may be removed).
documented
Forms · 3
- Get formGET /lists/{list_id}/forms/{form_id}.json
Retrieve details for a specific form belonging to a list.
documented - List forms by typeGET /lists/{list_id}/forms.json?filter[form_type]={form_type}
Filter forms by type (0=Signup Page, 1=Embed Signup, 2=Wordpress Signup, 3=Facebook Signup) for a given list.
documented - List forms for a listGET /lists/{list_id}/forms.json
Retrieve forms that are associated with a specific list.
documented
Lists · 3
- List listsGET /lists.json
Retrieve a collection of Campayn contact lists visible to the authenticated user.
documented - Unsubscribe contact from list (by ID)POST /lists/{list_id}/unsubscribe.json
Unsubscribe a contact from a specific list using their internal list contact ID (request body should include {"id":"..."}).
documented - Unsubscribe contact from list (by email)POST /lists/{list_id}/unsubscribe.json
Unsubscribe contacts from a specific list by email address (request body should include {"email":"..."}).
documented