List Subscriber Permissions

Name Description
HTTP Method GET
URL https://api.newsweaver.com/v2/{account code}/subscriber/{subscriber identifier}/permissions
https://api.newsweaver.com/v2/{account code}/subscriber/{subscriber email}/permissions
Query Parameters N/A
Request representation N/A
Response representation Subscriber Permission List
Success Response Code 200 Ok

Errors

  • 403 - Forbidden if API user doesn't have READ access to GLOBAL_SUBSCRIBERS and EMAIL_PERMISSIONS
  • 404 - Not Found if subscriber doesn't exist
  • Common errors (user/account authentication errors, API usage limit errors)

Example: GET https://api.newsweaver.com/v2/sample-account/subscriber/joe.bloggs@example.com/permissions

<subscriber_permissions total="2" uri="https://api.newsweaver.com/v2/example-account/subscriber/joe.bloggs@example.com/permissions">
    <itemsPerPage>1000</itemsPerPage>
    <startIndex>0</startIndex>
    <totalResults>2</totalResults>
    <subscriber_permission name="Prospective Students" uri="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc/permission/Prospective%20Students">
        <link
            href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc"
            rel="http://api-info.newsweaver.com/v2/rels/subscriber_permission.subscriber"
            title="Subscriber (1dc0ag2floc)"/>
        <link
            href="https://api.newsweaver.com/v2/example-account/permission/Prospective%20Students"
            rel="http://api-info.newsweaver.com/v2/rels/subscriber_permission.permission"
            title="Permission (Prospective Students)"/>
    </subscriber_permission>
    <subscriber_permission name="Student" uri="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc/permission/Student">
        <link
            href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc"
            rel="http://api-info.newsweaver.com/v2/rels/subscriber_permission.subscriber"
            title="Subscriber (1dc0ag2floc)"/>
        <link
            href="https://api.newsweaver.com/v2/example-account/permission/Student"
            rel="http://api-info.newsweaver.com/v2/rels/subscriber_permission.permission"
            title="Permission (Student)"/>
    </subscriber_permission>
</subscriber_permissions>

results matching ""

    No results matching ""