Unsubscribe Groups

Check unsubscribe group membership

Returns the unsubscribe groups a contact has left, optionally limited to a specified set of groups. Name the contact by exactly one of contactId, email, or phone. Membership belongs to the contact, so the answer is the same whichever identifier names it; contactId is null, and no groups are returned, when no contact holds the email or phone.

get/v1/unsubscribe-groups/check

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/unsubscribe-groups/check
  • Auth: API key in header x-api-key

Query parameters

contactIdstring
emailstring nullable
phonestring nullable
groupIdsstring nullable

Response

Success

contactIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.