All integrations

Campayn

MARKETING · MARKETING

Lists, contacts, forms, and email reports in the account they connected.

Connecting Campayn in practice

Campayn authenticates with a scheme of its own invention — "Authorization: TRUEREST apikey=1297sadasdas9123990123" — which no standard HTTP client or OAuth-shaped agent framework will produce without hand-rolling the header, and the key is one account-wide credential with no scopes.

Worth knowing

  • The TRUEREST prefix is not a bearer token, so libraries that set Authorization for you have to be bypassed; get the prefix wrong and the failure looks like a bad key.
  • Regenerating the key from the Account section takes effect immediately and "the old key will no longer be valid", so rotation is a hard cutover with no overlap window.
  • JSON is the only supported format for both requests and responses, and while GET, POST, PUT and DELETE are all used, "not every verb is available for every endpoint", so capability has to be checked resource by resource.
  • The resource set is small — Lists, Contacts, Forms, Emails, Reports and Signup — and the authoritative documentation is a GitHub repository rather than a docs site, so there is no versioned reference to diff against.

Checked against Campayn API (2026-09-29), Campayn API documentation (official repository) (2026-09-29)

Acts as the person, not as itself

Each user connects their own account. Every call carries both identities — the agent and the person it is acting for — so the agent can never reach past what that individual can already do.

Credentials never touch the agent

Tokens live in the vault and attach server-side at call time. The agent holds a session, not a secret, and revoking access does not mean rotating a key.

Every call on the record

Who asked, which agent acted, which action ran, and the verdict that let it through — one audit trail across every integration, not one per vendor.

What an agent can do

Each action is granted on its own. An agent allowed to read is not thereby allowed to write, and the scope beside each row is what the acting user must have connected for it to run at all.

campayn_get_contacts_by_contact_id_jsonREAD

Get a Contact via GET /contacts/{contact_id}.json. Gets one contact in full, by id and independently of any list: name, title, company, e-mail, birthday, the postal address fields, tags, and the phone, site, social and custom-field collections.

api
campayn_get_emails_jsonREAD

Get Emails via GET /emails.json. Returns the account's e-mails with their delivery and engagement figures -- status, campaign title, scheduled date, send count, unique views and responses and the matching percentages, and the preview URL and thumbnail.

api
campayn_get_lists_by_list_id_contacts_jsonREAD

Get Contacts via GET /lists/{list_id}/contacts.json. Lists the contacts on one list -- id, e-mail, first and last name and image URL -- and accepts Campayn's `filter[contact]` selector to narrow the result.

api
campayn_get_lists_by_list_id_forms_by_form_id_jsonREAD

Get a Form via GET /lists/{list_id}/forms/{form_id}.json. Gets one signup form on a list: its id, title, type, signup count and the form's own HTML.

api
campayn_get_lists_by_list_id_forms_jsonREAD

Get Forms via GET /lists/{list_id}/forms.json. Lists the signup forms attached to one list, each with its id, title, type, signup count and the form's own HTML. Campayn's `filter[form_type]` selector narrows the result to one of its four form types.

api
campayn_get_lists_jsonREAD

Get Lists via GET /lists.json. Returns every contact list on the account, each with its id, list name, tags and contact count. The only parameter-free read in the Campayn surface.

api
campayn_get_reports_calendar_jsonREAD

Get Calendar Report via GET /reports/calendar.json. Returns the account's e-mails as calendar entries -- id, name, status, scheduled date, preview URL and report URL -- optionally bounded by the `from` and `to` window.

api
campayn_post_lists_by_list_id_contacts_jsonWRITE

Add Contact via POST /lists/{list_id}/contacts.json. Adds a contact to one list. Only `email` is required; the name, title, company, address, phone, site, social and custom-field values are optional, and `failOnDuplicate` decides whether an address already on the list is an error rather than a no-op.

api
campayn_post_lists_by_listid_unsubscribe_jsonWRITE

Unsubscribe Contact via POST /lists/{listId}/unsubscribe.json. Unsubscribes a contact from one list, named either by contact id or by e-mail address. Answers a success envelope with the resulting contact and unsubscribe counts. The ledger classifies this destructive: an unsubscribe is a consent decision and Campayn publishes no call that reverses it.

api
campayn_post_signupWRITE

Sign Up a New User via POST /signup. Provisions a new Campayn USER account (with its own campayn.com subdomain) from an e-mail, first and last name and password. SEPARATELY AUTHORIZED: Campayn treats this as a privileged call and grants it on an API key out of band, so a key that reaches every other Campayn tool may still answer {"success": 0, "msg": "API key is not authorized for the \"signup\" action"}. That is a capability answer about this one action, NOT a dead credential -- do not re-paste the key; ask Campayn to authorize it for the signup action. The other documented refusal is an ordinary validation failure (the e-mail is already taken).

api

Put Campayn behind one governed endpoint.

Same permissions, same audit trail, whatever else you connect next.