Get a contact marketing roster

get

/services/rest/connect/v1.4/contactMarketingRosters/{id}

Request

Path Parameters
  • The unique identifier of the contact marketing roster.
Back to Top

Response

Default Response

Body ()
Root Schema : contactMarketingRosters
Type: object
The information about the contact lists used in audiences in Oracle Service Cloud Outreach Cloud Service.
Show Source
Nested Schema : interface
Type: object
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : contactMarketingRosters-lastCountStatistics
Type: object
The last count-related information of the contact marketing roster.
Show Source
Back to Top

Examples

Use GET with the following syntax to retrieve data for a contact marketing roster:

https://your_site_interface/services/rest/connect/version/contactMarketingRosters/contact_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/contactMarketingRosters/13

Response body example

{
    "id": 13,
    "lookupName": "Outreach Contacts",
    "createdTime": "2018-04-17T10:03:16.000Z",
    "updatedTime": "2018-04-17T10:03:16.000Z",
    "comment": null,
    "createdByAccount": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2"
            },
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2"
            },
            {
                "rel": "describedby",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
                "mediaType": "application/schema+json"
            }
        ]
    },
    "interface": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/siteInterfaces/1"
            },
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/siteInterfaces/1"
            },
            {
                "rel": "describedby",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/siteInterfaces",
                "mediaType": "application/schema+json"
            }
        ]
    },
    "isProofList": false,
    "lastCountStatistics": {},
    "name": "Outreach Contacts",
    "purgeData": false,
    "updatedByAccount": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2"
            },
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2"
            },
            {
                "rel": "describedby",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
                "mediaType": "application/schema+json"
            }
        ]
    },
    "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/contactMarketingRosters/13"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/contactMarketingRosters/13"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/contactMarketingRosters",
            "mediaType": "application/schema+json"
        }
    ]
}
Back to Top