Service Customer Audiences v4.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

An audience is a subset of banking customers (members) as selected by some filter criteria. Audiences (sometimes called a customer segmentation) may be used to define a target set of customers for a marketing or communication campaign, or to define analytics related to the customers in that subset. Audiences are defined and managed by financial institution administrators and analysts. Each analyst can list and view all audiences they have created and those which others have shared with them. Analysts can create or copy audiences. Audiences can be shared with other analysts who are collaborators.

An Audience Template allows banking customers to create audiences with a pre-defined set of filters. To create a new customer audience from a template, pass the id of the template as the ?customerAudienceTemplateId= query parameter on the create the customer audience operation. To override the filters in the referenced customer audience template, include them in the request body; otherwise the new audience uses the filters from the customer audience template. Customer audiences cannot be created from customer audience templates whenever the template is in the institution's excludedCustomerAudienceTemplates.

API Identities

This API is designed to be called from the following identity types:

Secure service client

Download OpenAPI Definition (YAML)

Base URLs:

https://api.apiture.com/service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

API Key (apiKey)
- header parameter: API-Key
- API Key based client identification. See details at API Keys.

OAuth2 authentication (clientCredentials)
- Client Credentials OAuth2 flow that allows a secure service application to access resources. (This access is not used with insecure clients such as web or mobile applications.) See details at Secure Access.
- Flow: clientCredentials
- Token URL = https://dev-oidc.apiture-comm-nonprod.com/oidc/token

Scope	Scope Description
`bankingAdmin/read`	Read a wide variety of banking and other financial institution and customer data.
`bankingAdmin/write`	Write a wide variety of banking and other financial institution and customer data.
`adminData/read`	Read access to non-banking data and resources.
`adminData/write`	Read, write, and delete access to non-banking data and resources.
`samlPlatform/write`	Write access to security-critical Apiture internal key and certificate data.
`samlPlatform/read`	Read access to integration resources, e.g. supported codes.
`samlAdmin/write`	Write, delete and execute access to service provider metadata and SAML computation operations.
`systemIntegrations/read`	Read access to integration definition resources.
`systemIntegrations/write`	Write, delete and execute access to integration definition resources.

Customer Audiences

Banking Customer Audiences

listCustomerAudienceCustomers

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a page of customers in a customer audience

GET https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers

Return a page of customers for this customer audience. This is a set of data for banking customers who satisfy the filter criteria defined by this customer audience. There can be many thousands or even millions of customers, so the client must fetch these via pagination with a maximum limit of 100,000 customers per page. The customer audience resource indicates how many customers satisfy the audience filter criteria.

Parameters

Parameter	Description
`start` `in: query`	`string` The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. `maxLength: 256` `default: ""` `pattern: "^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$"`
`limit` `in: query`	`integer(int32)` The maximum number of items to return in this paged response. `format: int32` `minimum: 0` `maximum: 100000` `default: 10000`
`customerAudienceId` `in: path`	`resourceId` (required) The unique identifier of this customer audience. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "count": 189,
  "items": [
    {
      "dataCustomerId": "9dfb049f5672424d7b3b",
      "customerId": "d884eab0082669f519b0",
      "primaryPhoneNumber": "+19992345678",
      "primaryEmail": "email@example.com"
    },
    {
      "dataCustomerId": "f26c043c527f42430b15",
      "customerId": "c3aadd481d5301b568e6",
      "primaryPhoneNumber": "+11112345678",
      "primaryEmail": "api@example.com"
    },
    {
      "dataCustomerId": "40ce35bd15417a2e2a09",
      "customerId": "63d87c56c86fc231f20f"
    },
    {
      "dataCustomerId": "c84fd4b81049c27d4a65",
      "customerId": "936a1b266f88066d9c97"
    },
    {
      "dataCustomerId": "b8e93bb1bd22dba4093c",
      "customerId": "80f3a986ab155a4e740e"
    },
    {
      "dataCustomerId": "c5247e8f5de1a4e79f67",
      "customerId": "514434dfd748d66f506c"
    },
    {
      "dataCustomerId": "5e979274f87e41eee739",
      "customerId": "4b6b478295c150ae7a7e"
    },
    {
      "dataCustomerId": "6dc7c36cb2306288919f",
      "customerId": "f31508460b6329cc6f9a"
    },
    {
      "dataCustomerId": "09c8fdf03607d0e12c91"
    },
    {
      "dataCustomerId": "c50aae5d1be0ad19ca5b"
    }
  ],
  "nextPage_url": "https://production.api.apiture.com/bankingAdmin/customerAudiences/0399abedfd3d/customers?start=74f96e77c3aafcb9fe85?limit=10"
}

Responses

Status	Description
200	OK
	OK.
	Schema: `customerAudienceCustomers`

Status Description

401 Unauthorized

Status	Description
401	Unauthorized
	Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/unauthorized/v1.0.0` The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.
	Schema: `Inline`

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Status	Description
403	Forbidden
	Forbidden. The authenticated caller is not authorized to perform the requested operation. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/forbidden/v1.0.0` The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation. `https://production.api.apiture.com/errors/customerDisabled/v1.0.0` The customer is disabled. Remediation: Have the customer contact the financial institution for support. `https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0` The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software. `https://production.api.apiture.com/errors/modificationForbidden/v1.0.0` The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization. `https://production.api.apiture.com/errors/challengeRequired/v1.0.0` The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call. The `attributes` object in the error may have the properties defined by the `requiredIdentityChallenge` schema. `https://production.api.apiture.com/errors/challengeBlocked/v1.0.0` The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again. `https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0` This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors. `https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0` The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
	Schema: `Inline`

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such customer audience resource at the specified `{customerAudienceId}`.
	Schema: `problemResponse`

Status Description

422 Unprocessable Entity

Status	Description
422	Unprocessable Entity
	Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0` The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.
	Schema: `Inline`

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0
The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.

Schema: Inline

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

listCustomerAudiences

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/service/customerAudiences \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/customerAudiences HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudiences',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudiences',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/service/customerAudiences',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/service/customerAudiences', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudiences");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/service/customerAudiences", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of customer audiences

GET https://api.apiture.com/service/customerAudiences

Return a collection of customer audiences for the current analyst. This includes audiences the analyst has created and audiences that others have shared with them.

Parameters

Parameter	Description
`q` `in: query`	`string(text)` Optional search string. This search is case insensitive and will return audiences where any part of the name or description matches the search string. See "Using Search Strings" in the Admin Search API for details on searching for multiple words. `format: text` `minLength: 1` `maxLength: 1000`
`state` `in: query`	`array[string]` Filter the response to only audiences whose `state` is in this pipe-delimited set of state names. `unique items` `minItems: 1` `maxItems: 2` `pipe-delimited` items: `string` » enum values: `active`, `archived`
`source` `in: query`	`array[string]` Filter the response to only audiences whose `source` is in this pipe-delimited set of source values. `unique items` `minItems: 1` `maxItems: 4` `pipe-delimited` items: `string` » enum values: `filter`, `insight`, `list`, `template`, `campaign`
`enrollmentState` `in: query`	`array[string]` Filter the response to only audiences whose `enrollmentState` is in this pipe-delimited set of values. Note: The `enrollmentState` query parameter value `all` is not a catchall term to return all possible audiences regardless of their `enrollmentState`. Using `?enrollmentState=all` will only return audiences with an `enrollmentState` that is set to `all`. `unique items` `minItems: 1` `maxItems: 5` `pipe-delimited` items: `string` » enum values: `all`, `customer`, `enrolled`, `unenrolled`, `applicant`
`campaign` `in: query`	`resourceId` Returns audiences created from a campaign's engagement data, where the campaign's ID matches the given campaign parameter value. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "items": [
    {
      "name": "Most valuable customers",
      "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
      "customerType": "retail",
      "enrollmentState": "enrolled",
      "customerCount": 12340,
      "retailCustomerCount": 10000,
      "commercialCustomerCount": 2340,
      "enrolledCustomerCount": 12300,
      "unenrolledCustomerCount": 40,
      "applicantCount": 100,
      "totalCustomerCount": 2340659,
      "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
      "id": "0399abedfd3d",
      "state": "active",
      "createdAt": "2023-04-14T06:47:53.375Z",
      "updatedAt": "2023-04-24T08:48:05.000Z",
      "source": "list",
      "owners": [
        {
          "id": "0399abedfd3d",
          "firstName": "Bob",
          "lastName": "Hartley",
          "username": "bhartley"
        }
      ],
      "updatedBy": {
        "id": "0399abedfd3d",
        "firstName": "Bob",
        "lastName": "Hartley",
        "username": "bhartley"
      },
      "collaborators": [
        {
          "id": "0399abedfd3d",
          "firstName": "Bob",
          "lastName": "Hartley",
          "username": "bhartley"
        },
        {
          "id": "389a2238d9f5c275d172",
          "firstName": "Carol",
          "lastName": "Wallace",
          "username": "cwallace"
        },
        {
          "id": "69fdb75ba971f3291432",
          "firstName": "Jerry",
          "lastName": "Robinson",
          "username": "jrobinson"
        }
      ],
      "connections": [
        {
          "id": "0399abed-fd3d",
          "state": "active",
          "provider": {
            "name": "pendo",
            "resourceId": "q6PioQIWPFAhOA"
          }
        }
      ],
      "identifierType": "customerId",
      "includesHeader": true
    }
  ]
}

Responses

Status	Description
200	OK
	OK.
	Schema: `customerAudiences`

Status Description

400 Bad Request

Status	Description
400	Bad Request
	Bad Request. The request body, request headers, and/or query parameters are not well-formed. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/badRequest/v1.0.0` The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.
	Schema: `Inline`

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Status	Description
401	Unauthorized
	Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/unauthorized/v1.0.0` The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.
	Schema: `Inline`

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Status	Description
403	Forbidden
	Forbidden. The authenticated caller is not authorized to perform the requested operation. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/forbidden/v1.0.0` The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation. `https://production.api.apiture.com/errors/customerDisabled/v1.0.0` The customer is disabled. Remediation: Have the customer contact the financial institution for support. `https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0` The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software. `https://production.api.apiture.com/errors/modificationForbidden/v1.0.0` The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization. `https://production.api.apiture.com/errors/challengeRequired/v1.0.0` The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call. The `attributes` object in the error may have the properties defined by the `requiredIdentityChallenge` schema. `https://production.api.apiture.com/errors/challengeBlocked/v1.0.0` The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again. `https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0` This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors. `https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0` The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
	Schema: `Inline`

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

422 Unprocessable Entity

Status	Description
422	Unprocessable Entity
	Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0` The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.
	Schema: `Inline`

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0
The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.

Schema: Inline

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

createCustomerAudience

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/service/customerAudiences \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/service/customerAudiences HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudiences',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudiences',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/service/customerAudiences',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.apiture.com/service/customerAudiences', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudiences");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/service/customerAudiences", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new customer audience

POST https://api.apiture.com/service/customerAudiences

Create a new customer audience within the customer audiences collection. If an insightId is given, then the resulting audience is all customers who satisfy both the filters in the insight and satisfy the filters in this request.

Body parameter

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled"
}

Parameters

Parameter	Description
`copyOf` `in: query`	`resourceId` Copy the properties and filters of the referenced audience resource, except the collaborators. The `copyOf` parameter is the resource `id` of the source audience resource. Values in the request body override the values from the source. `insightId`, `customerAudienceTemplateId`, `campaignId` and `copyOf` are mutually exclusive. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`insightId` `in: query`	`resourceId` Create an audience from the referenced audience insight resource. This value is the `id` of the insight instance. Other attributes of the resulting audience (the `customerType`, `filters`) are immutable in the new `customerType` audience. `insightId`, `customerAudienceTemplateId`, `campaignId`, and `copyOf` are mutually exclusive. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`customerAudienceTemplateId` `in: query`	`resourceId` If passed, this parameter indicates the audience was derived from a customer audience template. The value of this parameter is the `id` of that customer audience template. `insightId`, `customerAudienceTemplateId`, `campaignId`, and `copyOf` are mutually exclusive. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`campaignId` `in: query`	`resourceId` If passed, this parameter indicates the audience was derived from a campaign's engagement data. The value of this parameter is the `id` of that campaign. This parameter does not automatically apply any filters to the audience. Filters must be added to the audience that indicate which engagement properties are used to create the audience. `insightId`, `customerAudienceTemplateId`, `campaignId`, and `copyOf` are mutually exclusive. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`body`	`newCustomerAudience` (required) The data necessary to create a new customer audience.
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

201 Response

{
  "name": "Most valuable customers",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled",
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "owners": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ],
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ],
  "connections": [
    {
      "id": "0399abed-fd3d",
      "state": "active",
      "provider": {
        "name": "pendo",
        "resourceId": "q6PioQIWPFAhOA"
      }
    }
  ],
  "identifierType": "customerId",
  "includesHeader": true
}

Responses

Status	Description
201	Created
	Created.
	Schema: `customerAudience`
Header	`Location` `string` `uri-reference`
	The URI of the new customer audience.
Header	`ETag` `string`
	The value of this resource's entity tag, to be passed with `If-Match` and `If-None-Match` request headers in other conditional API calls for this resource.

Status Description

400 Bad Request

Status	Description
400	Bad Request
	Bad Request. The request body, request headers, and/or query parameters are not well-formed. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/badRequest/v1.0.0` The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.
	Schema: `Inline`

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Status	Description
401	Unauthorized
	Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/unauthorized/v1.0.0` The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.
	Schema: `Inline`

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Status	Description
403	Forbidden
	Forbidden. The authenticated caller is not authorized to perform the requested operation. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/forbidden/v1.0.0` The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation. `https://production.api.apiture.com/errors/customerDisabled/v1.0.0` The customer is disabled. Remediation: Have the customer contact the financial institution for support. `https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0` The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software. `https://production.api.apiture.com/errors/modificationForbidden/v1.0.0` The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization. `https://production.api.apiture.com/errors/challengeRequired/v1.0.0` The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call. The `attributes` object in the error may have the properties defined by the `requiredIdentityChallenge` schema. `https://production.api.apiture.com/errors/challengeBlocked/v1.0.0` The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again. `https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0` This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors. `https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0` The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
	Schema: `Inline`

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

422 Unprocessable Entity

Status	Description
422	Unprocessable Entity
	Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/invalidSourceAudience/v1.0.0` The source audience does not exist or is not an audience that is eligible to be copied. Remediation: Pass the `id` of a mutable, copyable audience. `https://production.api.apiture.com/errors/invalidCustomerAudienceFilters/v1.0.0` The given customer audience filters are invalid. The filters are not customer filters, or the filter type is not found, or the filter values do not satisfy the constraints of that filter type. Remediation: Correct the filters according to the `detail` and/or `problems` in the problem response. The `attributes` object in the error may have the properties defined for `invalidCustomerAudienceFilters`. `https://production.api.apiture.com/errors/duplicateFilterOrdinals/v1.0.0` Two or more filters in the request have the same ordinal. Remediation: Resubmit the request such that all filters have unique ordinals. `https://production.api.apiture.com/errors/invalidFilterOrdinals/v1.0.0` Ordinals were not provided for all filters. If ordinals are provided, then they must be set for every filter. Remediation: Resubmit the request such that all filters have unique ordinals, or remove all ordinals. `https://production.api.apiture.com/errors/invalidSourceInsight/v1.0.0` The source data does not exist or is not eligible to be used for audience creation. Remediation: Resubmit the request with the `id` of an eligible insight. `https://production.api.apiture.com/errors/invalidCustomerAudienceTemplate/v1.0.0` The source customer audience template does not exist or is not eligible to be used for audience creation. Remediation: Resubmit the request with the `id` of an eligible customer audience template. If this template is in the institution's `excludedCustomerAudienceTemplates`, then remove it and retry the operation. `https://production.api.apiture.com/errors/invalidCreateAudienceQueryParameters/v1.0.0` The `insightId`, `customerAudienceTemplateId`, and `copyOf` query parameters are mutually exclusive, and cannot be combined in a single request to create an audience. Remediation: Resubmit the request with only one of the following query parameters: `insightId`, `customerAudienceTemplateId`, or `copyOf`. `https://production.api.apiture.com/errors/invalidCampaign/v1.0.0` The campapign does not exist or is not a campaign that has eligible engagement data to create an audience from. Remediation: Pass the `id` of a campaign with valid engagement data.
	Schema: `problemResponse`

Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/invalidSourceAudience/v1.0.0
The source audience does not exist or is not an audience that is eligible to be copied. Remediation: Pass the id of a mutable, copyable audience.
https://production.api.apiture.com/errors/invalidCustomerAudienceFilters/v1.0.0
The given customer audience filters are invalid. The filters are not customer filters, or the filter type is not found, or the filter values do not satisfy the constraints of that filter type. Remediation: Correct the filters according to the detail and/or problems in the problem response. The attributes object in the error may have the properties defined for invalidCustomerAudienceFilters.
https://production.api.apiture.com/errors/duplicateFilterOrdinals/v1.0.0
Two or more filters in the request have the same ordinal. Remediation: Resubmit the request such that all filters have unique ordinals.
https://production.api.apiture.com/errors/invalidFilterOrdinals/v1.0.0
Ordinals were not provided for all filters. If ordinals are provided, then they must be set for every filter. Remediation: Resubmit the request such that all filters have unique ordinals, or remove all ordinals.
https://production.api.apiture.com/errors/invalidSourceInsight/v1.0.0
The source data does not exist or is not eligible to be used for audience creation. Remediation: Resubmit the request with the id of an eligible insight.
https://production.api.apiture.com/errors/invalidCustomerAudienceTemplate/v1.0.0
The source customer audience template does not exist or is not eligible to be used for audience creation. Remediation: Resubmit the request with the id of an eligible customer audience template. If this template is in the institution's excludedCustomerAudienceTemplates, then remove it and retry the operation.
https://production.api.apiture.com/errors/invalidCreateAudienceQueryParameters/v1.0.0
The insightId, customerAudienceTemplateId, and copyOf query parameters are mutually exclusive, and cannot be combined in a single request to create an audience. Remediation: Resubmit the request with only one of the following query parameters: insightId, customerAudienceTemplateId, or copyOf.
https://production.api.apiture.com/errors/invalidCampaign/v1.0.0
The campapign does not exist or is not a campaign that has eligible engagement data to create an audience from. Remediation: Pass the id of a campaign with valid engagement data.

Schema: problemResponse

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getCustomerAudience

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/service/customerAudiences/{customerAudienceId} \
  -H 'Accept: application/json' \
  -H 'If-None-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/customerAudiences/{customerAudienceId} HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-None-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'If-None-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudiences/{customerAudienceId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'If-None-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'If-None-Match' => 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'If-None-Match': 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/service/customerAudiences/{customerAudienceId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudiences/{customerAudienceId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "If-None-Match": []string{"W/"325cf1cc-e370-4baf-8faf-c6db23f195a2""},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/service/customerAudiences/{customerAudienceId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this customer audience

GET https://api.apiture.com/service/customerAudiences/{customerAudienceId}

Return the JSON representation of this customer audience resource.

Parameters

Parameter	Description
`If-None-Match` `in: header`	`entityTag` The entity tag that was returned in the `ETag` response header of a previous call. If the resource's current entity tag value matches this header value, the `GET` will return 304 (Not Modified) and no response body, else the current resource representation and updated `ETag` is returned. `minLength: 3` `maxLength: 512` `pattern: "^((\\\"?[\\x21\\x23-\\x7e]{1,512}\\\"?)\|(W\\/\\\"[\\x21\\x23-\\x7e]{1,509}\\\"))$"`
`customerAudienceId` `in: path`	`resourceId` (required) The unique identifier of this customer audience. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "name": "Most valuable customers",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled",
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "owners": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ],
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ],
  "connections": [
    {
      "id": "0399abed-fd3d",
      "state": "active",
      "provider": {
        "name": "pendo",
        "resourceId": "q6PioQIWPFAhOA"
      }
    }
  ],
  "identifierType": "customerId",
  "includesHeader": true
}

Responses

Status	Description
200	OK
	OK.
	Schema: `customerAudience`
Header	`ETag` `string`
	The value of this resource's entity tag, to be passed with `If-Match` and `If-None-Match` request headers in other conditional API calls for this resource.

Status Description

400 Bad Request

Status	Description
400	Bad Request
	Bad Request. The request body, request headers, and/or query parameters are not well-formed. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/badRequest/v1.0.0` The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.
	Schema: `Inline`

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such customer audience resource at the specified `{customerAudienceId}`.
	Schema: `problemResponse`

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

patchCustomerAudience

Code samples

# You can also use wget
curl -X PATCH https://api.apiture.com/service/customerAudiences/{customerAudienceId} \
  -H 'Content-Type: application/merge-patch+json' \
  -H 'Accept: application/json' \
  -H 'If-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.apiture.com/service/customerAudiences/{customerAudienceId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: application/json
If-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"

const fetch = require('node-fetch');
const inputBody = '{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled"
}';
const headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'If-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudiences/{customerAudienceId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'If-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/merge-patch+json',
  'Accept' => 'application/json',
  'If-Match' => 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/merge-patch+json',
  'Accept': 'application/json',
  'If-Match': 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.apiture.com/service/customerAudiences/{customerAudienceId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudiences/{customerAudienceId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/merge-patch+json"},
        "Accept": []string{"application/json"},
        "If-Match": []string{"W/"325cf1cc-e370-4baf-8faf-c6db23f195a2""},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.apiture.com/service/customerAudiences/{customerAudienceId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this customer audience

PATCH https://api.apiture.com/service/customerAudiences/{customerAudienceId}

Perform a partial update of this customer audience as per JSON Merge Patch format and processing rules. Only fields in the request body are updated on the resource; fields which are omitted are not updated.

Body parameter

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled"
}

Parameters

Parameter	Description
`If-Match` `in: header`	`entityTag` The entity tag that was returned in the `ETag` response header of a previous call. If passed, this must match the current entity tag of the resource, else the operation fails with a 412 Precondition Failed error. `minLength: 3` `maxLength: 512` `pattern: "^((\\\"?[\\x21\\x23-\\x7e]{1,512}\\\"?)\|(W\\/\\\"[\\x21\\x23-\\x7e]{1,509}\\\"))$"`
`body`	`customerAudiencePatch` (required) The fields to update within the customer audience.
`customerAudienceId` `in: path`	`resourceId` (required) The unique identifier of this customer audience. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "name": "Most valuable customers",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled",
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "owners": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ],
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ],
  "connections": [
    {
      "id": "0399abed-fd3d",
      "state": "active",
      "provider": {
        "name": "pendo",
        "resourceId": "q6PioQIWPFAhOA"
      }
    }
  ],
  "identifierType": "customerId",
  "includesHeader": true
}

Responses

Status	Description
200	OK
	OK.
	Schema: `customerAudience`
Header	`ETag` `string`
	The value of this resource's entity tag, to be passed with `If-Match` and `If-None-Match` request headers in other conditional API calls for this resource.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such customer audience resource at the specified `{customerAudienceId}`.
	Schema: `problemResponse`

Status Description

409 Conflict

Conflict.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/cannotUpdateImmutableAudienceProperties/v1.0.0
The customerType and filters of an audience created from an insight are not mutable. Remediation: Omit customerType and filters from the request and retry the operation.
https://production.api.apiture.com/errors/cannotUpdateInUseAudience/v1.0.0
Cannot update, delete, or archive an audience that is used by another resource, such as a campaign. Remediation: Update or delete the resources that use this audience, then retry the operation.

Schema: problemResponse

Status Description

412 Precondition Failed

Precondition Failed. One or more conditions given in the request header fields evaluated to false when tested on the server.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/preconditionFailed/v1.0.0
One or more conditions given in the request header fields evaluated to false when tested on the server. Remediation: Update resources and use it's most recent ETag or modification time stamp.

Schema: problemResponse

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/invalidCustomerAudienceFilters/v1.0.0
The given customer audience filters are invalid. The filters are not customer filters, or the filter type is not found, or the filter values do not satisfy the constraints of that filter type. Remediation: Correct the filters according to the detail and/or problems in the problem response. The attributes object in the error may have the properties defined for invalidCustomerAudienceFilters.
https://production.api.apiture.com/errors/duplicateFilterOrdinals/v1.0.0
Two or more filters in the request have the same ordinal. Remediation: Resubmit the request such that all filters have unique ordinals.
https://production.api.apiture.com/errors/invalidFilterOrdinals/v1.0.0
Ordinals were not provided for all filters. If ordinals are provided, then they must be set for every filter. Remediation: Resubmit the request such that all filters have unique ordinals, or remove all ordinals.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

deleteCustomerAudience

Code samples

# You can also use wget
curl -X DELETE https://api.apiture.com/service/customerAudiences/{customerAudienceId} \
  -H 'Accept: application/problem+json' \
  -H 'If-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.apiture.com/service/customerAudiences/{customerAudienceId} HTTP/1.1
Host: api.apiture.com
Accept: application/problem+json
If-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/problem+json',
  'If-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudiences/{customerAudienceId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/problem+json',
  'If-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/problem+json',
  'If-Match' => 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/problem+json',
  'If-Match': 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.apiture.com/service/customerAudiences/{customerAudienceId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudiences/{customerAudienceId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/problem+json"},
        "If-Match": []string{"W/"325cf1cc-e370-4baf-8faf-c6db23f195a2""},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.apiture.com/service/customerAudiences/{customerAudienceId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete this customer audience

DELETE https://api.apiture.com/service/customerAudiences/{customerAudienceId}

Delete this customer audience resource and any resources that are owned by it, including audience connections. Customer audiences that are used in scheduled, active, paused, or testing campaigns cannot be deleted. If an audience is deleted, then engagement data can still be retrieved for any completed campaign that was created from the audience.

Parameters

Parameter	Description
`If-Match` `in: header`	`entityTag` The entity tag that was returned in the `ETag` response header of a previous call. If passed, this must match the current entity tag of the resource, else the operation fails with a 412 Precondition Failed error. `minLength: 3` `maxLength: 512` `pattern: "^((\\\"?[\\x21\\x23-\\x7e]{1,512}\\\"?)\|(W\\/\\\"[\\x21\\x23-\\x7e]{1,509}\\\"))$"`
`customerAudienceId` `in: path`	`resourceId` (required) The unique identifier of this customer audience. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

400 Response

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/badRequest/v1.0.0",
  "title": "Bad Request",
  "status": 400,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "Input did not parse as JSON",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Responses

Status	Description
204	No Content
	No Content. The operation succeeded but returned no response body.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such customer audience resource at the specified `{customerAudienceId}`.
	Schema: `problemResponse`

Status Description

409 Conflict

Conflict.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/cannotUpdateInUseAudience/v1.0.0
Cannot update, delete, or archive an audience that is used by another resource, such as a campaign. Remediation: Update or delete the resources that use this audience, then retry the operation.

Schema: problemResponse

Status Description

412 Precondition Failed

Precondition Failed. One or more conditions given in the request header fields evaluated to false when tested on the server.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/preconditionFailed/v1.0.0
One or more conditions given in the request header fields evaluated to false when tested on the server. Remediation: Update resources and use it's most recent ETag or modification time stamp.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Customer Audience Actions

Actions on a Banking Customer Audience

archiveCustomerAudience

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/service/customerAudiences/{customerAudienceId}/archived \
  -H 'Accept: application/json' \
  -H 'If-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/service/customerAudiences/{customerAudienceId}/archived HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'If-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudiences/{customerAudienceId}/archived',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'If-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}/archived',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'If-Match' => 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}/archived',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'If-Match': 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.apiture.com/service/customerAudiences/{customerAudienceId}/archived', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudiences/{customerAudienceId}/archived");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "If-Match": []string{"W/"325cf1cc-e370-4baf-8faf-c6db23f195a2""},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/service/customerAudiences/{customerAudienceId}/archived", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Archive a customer audience

POST https://api.apiture.com/service/customerAudiences/{customerAudienceId}/archived

Archive a customer audience. This changes the state property of the customer audience to archived. The response is the updated representation of the customer audience. This operation is idempotent: no changes are made if the customer audience is already archived. Archived audiences are automatically removed 30 days after being archived.

Audiences that are in use elsewhere may not be archived.

Parameters

Parameter	Description
`If-Match` `in: header`	`entityTag` The entity tag that was returned in the `ETag` response header of a previous call. If passed, this must match the current entity tag of the resource, else the operation fails with a 412 Precondition Failed error. `minLength: 3` `maxLength: 512` `pattern: "^((\\\"?[\\x21\\x23-\\x7e]{1,512}\\\"?)\|(W\\/\\\"[\\x21\\x23-\\x7e]{1,509}\\\"))$"`
`customerAudienceId` `in: path`	`resourceId` (required) The unique identifier of this customer audience. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "name": "Most valuable customers",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled",
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "owners": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ],
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ],
  "connections": [
    {
      "id": "0399abed-fd3d",
      "state": "active",
      "provider": {
        "name": "pendo",
        "resourceId": "q6PioQIWPFAhOA"
      }
    }
  ],
  "identifierType": "customerId",
  "includesHeader": true
}

Responses

Status	Description
200	OK
	OK. The operation succeeded. The customer audience was updated and its `state` changed to `archived`.
	Schema: `customerAudience`
Header	`ETag` `string`
	The value of this resource's entity tag, to be passed with `If-Match` and `If-None-Match` request headers in other conditional API calls for this resource.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

409 Conflict

Conflict.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/cannotUpdateInUseAudience/v1.0.0
Cannot update, delete, or archive an audience that is used by another resource, such as a campaign. Remediation: Update or delete the resources that use this audience, then retry the operation.

Schema: problemResponse

Status Description

412 Precondition Failed

Precondition Failed. One or more conditions given in the request header fields evaluated to false when tested on the server.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/preconditionFailed/v1.0.0
One or more conditions given in the request header fields evaluated to false when tested on the server. Remediation: Update resources and use it's most recent ETag or modification time stamp.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

restoreCustomerAudience

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/service/customerAudiences/{customerAudienceId}/active \
  -H 'Accept: application/json' \
  -H 'If-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/service/customerAudiences/{customerAudienceId}/active HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'If-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudiences/{customerAudienceId}/active',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'If-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}/active',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'If-Match' => 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}/active',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'If-Match': 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.apiture.com/service/customerAudiences/{customerAudienceId}/active', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudiences/{customerAudienceId}/active");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "If-Match": []string{"W/"325cf1cc-e370-4baf-8faf-c6db23f195a2""},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/service/customerAudiences/{customerAudienceId}/active", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Restore an archived customer audience.

POST https://api.apiture.com/service/customerAudiences/{customerAudienceId}/active

Restore an archived customer audience. This changes the state property of the customer audience from archived to active. The response is the updated representation of the customer audience. This operation is idempotent: no changes are made if the customer audience is already active.

Parameters

Parameter	Description
`If-Match` `in: header`	`entityTag` The entity tag that was returned in the `ETag` response header of a previous call. If passed, this must match the current entity tag of the resource, else the operation fails with a 412 Precondition Failed error. `minLength: 3` `maxLength: 512` `pattern: "^((\\\"?[\\x21\\x23-\\x7e]{1,512}\\\"?)\|(W\\/\\\"[\\x21\\x23-\\x7e]{1,509}\\\"))$"`
`customerAudienceId` `in: path`	`resourceId` (required) The unique identifier of this customer audience. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "name": "Most valuable customers",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled",
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "owners": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ],
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ],
  "connections": [
    {
      "id": "0399abed-fd3d",
      "state": "active",
      "provider": {
        "name": "pendo",
        "resourceId": "q6PioQIWPFAhOA"
      }
    }
  ],
  "identifierType": "customerId",
  "includesHeader": true
}

Responses

Status	Description
200	OK
	OK. The operation succeeded. The customer audience was updated and its `state` changed to `active`.
	Schema: `customerAudience`
Header	`ETag` `string`
	The value of this resource's entity tag, to be passed with `If-Match` and `If-None-Match` request headers in other conditional API calls for this resource.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

412 Precondition Failed

Precondition Failed. One or more conditions given in the request header fields evaluated to false when tested on the server.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/preconditionFailed/v1.0.0
One or more conditions given in the request header fields evaluated to false when tested on the server. Remediation: Update resources and use it's most recent ETag or modification time stamp.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

importCustomerAudience

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/service/importedCustomerAudiences \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/service/importedCustomerAudiences HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "fileName": "2023_18to35_north_carolina.csv"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/importedCustomerAudiences',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/importedCustomerAudiences',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/service/importedCustomerAudiences',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.apiture.com/service/importedCustomerAudiences', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/importedCustomerAudiences");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/service/importedCustomerAudiences", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Import a customer audience

POST https://api.apiture.com/service/importedCustomerAudiences

Create a new customer audience from a file containing a list of customer identifiers. The import operation supports comma-separated values (CSV), plain text, and Microsoft Excel (.xls and .xlsx format) files with an optional header row. The file must consist of only one column of customer IDs. Files with additional columns result in import failures. The customers for the created audience may only be updated with updateCustomerAudienceCustomers.

Body parameter

{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "fileName": "2023_18to35_north_carolina.csv"
}

Parameters

Parameter	Description
`body`	`customerAudienceImport`
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

201 Response

{
  "name": "Most valuable customers",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled",
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "owners": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ],
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ],
  "connections": [
    {
      "id": "0399abed-fd3d",
      "state": "active",
      "provider": {
        "name": "pendo",
        "resourceId": "q6PioQIWPFAhOA"
      }
    }
  ],
  "identifierType": "customerId",
  "includesHeader": true,
  "unmatchedCount": 2,
  "unmatchedIds": [
    "c50aae5d1be0ad19ca5b",
    "f26c0-43c527f42430b15"
  ],
  "fileName": "2023_18to35_north_carolina.csv"
}

Responses

Status	Description
201	Created
	Created.
	Schema: `importedCustomerAudience`
202	Accepted
	Accepted. The request was accepted but the import is not yet complete. The results in the response reflect what was able to be processed in the allowed timeframe.
	Schema: `importedCustomerAudience`

Status Description

400 Bad Request

Bad Request. The request body and/or query parameters were well formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/emptyFileForImport/v1.0.0
The provided values file is empty. Remediation: Supply the values for import in Base64 encoding of a well-formed values file.
https://production.api.apiture.com/errors/tooFewColumnsInImport/v1.0.0
The parsed values file contains too many columns. Remediation: Supply the Base64 encoding of a well-formed values file with a single column.
https://production.api.apiture.com/errors/invalidContentFormat/v1.0.0
The format of the content for importing values is invalid. Remediation: Supply the Base64 encoding of a well-formed values file.

The content field allows comma-separated values (CSV), plain text, and Microsoft Excel (.xls and .xlsx) formats.

Schema: problemResponse

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0
The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

validateCustomerAudience

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/service/validatedCustomerAudiences \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/service/validatedCustomerAudiences HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "fileName": "2023_18to35_north_carolina.csv"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/validatedCustomerAudiences',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/validatedCustomerAudiences',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/service/validatedCustomerAudiences',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.apiture.com/service/validatedCustomerAudiences', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/validatedCustomerAudiences");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/service/validatedCustomerAudiences", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Validate a file of customer identifiers

POST https://api.apiture.com/service/validatedCustomerAudiences

Validate a file containing a list of customer identifiers. The operation supports comma-separated values (CSV), plain text, and Microsoft Excel (.xls and .xlsx format) files with an optional header row. The file must consist of only one column of customer IDs. Files with additional columns result in validation failures.

Body parameter

{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "fileName": "2023_18to35_north_carolina.csv"
}

Parameters

Parameter	Description
`body`	`customerAudienceImport`
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "unmatchedCount": 0,
  "unmatchedIds": []
}

Responses

Status	Description
200	OK
	OK.
	Schema: `validatedCustomerAudience`

Status Description

400 Bad Request

Bad Request. The request body and/or query parameters were well formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/emptyFileForImport/v1.0.0
The provided values file is empty. Remediation: Supply the values for import in Base64 encoding of a well-formed values file.
https://production.api.apiture.com/errors/tooFewColumnsInImport/v1.0.0
The parsed values file contains too many columns. Remediation: Supply the Base64 encoding of a well-formed values file with a single column.
https://production.api.apiture.com/errors/invalidContentFormat/v1.0.0
The format of the content for importing values is invalid. Remediation: Supply the Base64 encoding of a well-formed values file.

The content field allows comma-separated values (CSV), plain text, and Microsoft Excel (.xls and .xlsx) formats.

Schema: problemResponse

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0
The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

countAudienceCustomers

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/service/customerAudienceCounts \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/service/customerAudienceCounts HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "operator": "or",
  "primitiveFilters": [
    {
      "filterType": {
        "id": "215eaed841368ce154d5",
        "name": "customerType"
      },
      "operator": "equals",
      "values": [
        "retail"
      ],
      "ordinal": 0,
      "includeMissingValues": false
    },
    {
      "filterType": {
        "id": "6b3927745edec398ad74",
        "name": "customerAge"
      },
      "operator": "between",
      "values": [
        "35",
        "49"
      ],
      "ordinal": 1,
      "includeMissingValues": false
    }
  ],
  "compositeFilters": [
    {
      "operator": "and",
      "ordinal": 2,
      "primitiveFilters": [
        {
          "filterType": {
            "name": "customerRegion",
            "id": "01888d58e2424bf1c676"
          },
          "operator": "in",
          "values": [
            "NC",
            "SC",
            "GA",
            "FL"
          ],
          "ordinal": 0,
          "includeMissingValues": false
        },
        {
          "filterType": {
            "name": "accountBalance",
            "id": "023cd8af6a9d46eec506"
          },
          "operator": "greaterThan",
          "values": [
            "250000.00"
          ],
          "ordinal": 1,
          "includeMissingValues": false
        }
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudienceCounts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudienceCounts',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/service/customerAudienceCounts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.apiture.com/service/customerAudienceCounts', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudienceCounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/service/customerAudienceCounts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Count the customers who match a set of customer audience filters.

POST https://api.apiture.com/service/customerAudienceCounts

Return a count of the customers who match a set of customer audience filters and the total number of customers at the financial institution. If neither an insightId nor filter properties are given, then the full customer count is returned. If both insightId and filter properties are given, then then the returned count will include customers who satisfy both the filters in the insight and satisfy the filters in this request.

Body parameter

{
  "operator": "or",
  "primitiveFilters": [
    {
      "filterType": {
        "id": "215eaed841368ce154d5",
        "name": "customerType"
      },
      "operator": "equals",
      "values": [
        "retail"
      ],
      "ordinal": 0,
      "includeMissingValues": false
    },
    {
      "filterType": {
        "id": "6b3927745edec398ad74",
        "name": "customerAge"
      },
      "operator": "between",
      "values": [
        "35",
        "49"
      ],
      "ordinal": 1,
      "includeMissingValues": false
    }
  ],
  "compositeFilters": [
    {
      "operator": "and",
      "ordinal": 2,
      "primitiveFilters": [
        {
          "filterType": {
            "name": "customerRegion",
            "id": "01888d58e2424bf1c676"
          },
          "operator": "in",
          "values": [
            "NC",
            "SC",
            "GA",
            "FL"
          ],
          "ordinal": 0,
          "includeMissingValues": false
        },
        {
          "filterType": {
            "name": "accountBalance",
            "id": "023cd8af6a9d46eec506"
          },
          "operator": "greaterThan",
          "values": [
            "250000.00"
          ],
          "ordinal": 1,
          "includeMissingValues": false
        }
      ]
    }
  ]
}

Parameters

Parameter	Description
`body`	`customerAudienceCountsRequest` (required) The parameters to use when counting customers.
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
}

Responses

Status	Description
200	OK
	OK. The operation succeeded.
	Schema: `customerAudienceCounts`

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/invalidCustomerAudienceFilters/v1.0.0
The given customer audience filters are invalid. The filters are not customer filters, or the filter type is not found, or the filter values do not satisfy the constraints of that filter type. Remediation: Correct the filters according to the detail and/or problems in the problem response. The attributes object in the error may have the properties defined for invalidCustomerAudienceFilters.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

updateCustomerAudienceCustomers

Code samples

# You can also use wget
curl -X PUT https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'If-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
If-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"

const fetch = require('node-fetch');
const inputBody = '{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "fileName": "2023_18to35_north_carolina.csv"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'If-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'If-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'If-Match': 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "If-Match": []string{"W/"325cf1cc-e370-4baf-8faf-c6db23f195a2""},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update audience customers

PUT https://api.apiture.com/service/customerAudiences/{customerAudienceId}/customers

Replace the list of customers for this audience. This operation supports the same file content formats listed in importCustomerAudience. The customers for this audience may only be replaced if the audience was created with importCustomerAudience (that is, it has a source of list).

Body parameter

{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "fileName": "2023_18to35_north_carolina.csv"
}

Parameters

Parameter	Description
`If-Match` `in: header`	`entityTag` The entity tag that was returned in the `ETag` response header of a previous call. If passed, this must match the current entity tag of the resource, else the operation fails with a 412 Precondition Failed error. `minLength: 3` `maxLength: 512` `pattern: "^((\\\"?[\\x21\\x23-\\x7e]{1,512}\\\"?)\|(W\\/\\\"[\\x21\\x23-\\x7e]{1,509}\\\"))$"`
`body`	`customerAudienceCustomersImport`
`customerAudienceId` `in: path`	`resourceId` (required) The unique identifier of this customer audience. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "name": "Most valuable customers",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled",
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "owners": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ],
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ],
  "connections": [
    {
      "id": "0399abed-fd3d",
      "state": "active",
      "provider": {
        "name": "pendo",
        "resourceId": "q6PioQIWPFAhOA"
      }
    }
  ],
  "identifierType": "customerId",
  "includesHeader": true,
  "unmatchedCount": 2,
  "unmatchedIds": [
    "c50aae5d1be0ad19ca5b",
    "f26c0-43c527f42430b15"
  ],
  "fileName": "2023_18to35_north_carolina.csv"
}

Responses

Status	Description
200	OK
	OK.
	Schema: `importedCustomerAudience`
202	Accepted
	Accepted. The request was accepted but import is not yet complete. The results in the response reflect what was able to be processed in the allowed time.
	Schema: `importedCustomerAudience`

Status Description

400 Bad Request

Bad Request. The request body and/or query parameters were well formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/emptyFileForImport/v1.0.0
The provided values file is empty. Remediation: Supply the values for import in Base64 encoding of a well-formed values file.
https://production.api.apiture.com/errors/tooFewColumnsInImport/v1.0.0
The parsed values file contains too many columns. Remediation: Supply the Base64 encoding of a well-formed values file with a single column.
https://production.api.apiture.com/errors/invalidContentFormat/v1.0.0
The format of the content for importing values is invalid. Remediation: Supply the Base64 encoding of a well-formed values file.

The content field allows comma-separated values (CSV), plain text, and Microsoft Excel (.xls and .xlsx) formats.

Schema: problemResponse

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such customer audience resource at the specified `{customerAudienceId}`.
	Schema: `problemResponse`

Status Description

412 Precondition Failed

Precondition Failed. One or more conditions given in the request header fields evaluated to false when tested on the server.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/preconditionFailed/v1.0.0
One or more conditions given in the request header fields evaluated to false when tested on the server. Remediation: Update resources and use it's most recent ETag or modification time stamp.

Schema: problemResponse

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0
The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Customer Audience Collaborators

Collaborators on a Banking Customer Audience

listCustomerAudienceCollaborators

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/service/customerAudiences/{customerAudienceId}/collaborators \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/customerAudiences/{customerAudienceId}/collaborators HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudiences/{customerAudienceId}/collaborators',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}/collaborators',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/service/customerAudiences/{customerAudienceId}/collaborators',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/service/customerAudiences/{customerAudienceId}/collaborators', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudiences/{customerAudienceId}/collaborators");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/service/customerAudiences/{customerAudienceId}/collaborators", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch the list of audience collaborators

GET https://api.apiture.com/service/customerAudiences/{customerAudienceId}/collaborators

Fetch the list of collaborators for a customer audience.

Parameters

Parameter	Description
`customerAudienceId` `in: path`	`resourceId` (required) The unique identifier of this customer audience. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "owners": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ],
  "items": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ]
}

Responses

Status	Description
200	OK
	OK.
	Schema: `customerAudienceCollaborators`
Header	`ETag` `string`
	The value of this resource's entity tag, to be passed with `If-Match` and `If-None-Match` request headers in other conditional API calls for this resource.

Status	Description
304	Not Modified
	Not Modified. The resource has not been modified since it was last fetched.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Customer Audience Templates

Templates that data analysts can use to create Banking Customer Audiences

listCustomerAudienceTemplates

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/service/customerAudienceTemplates \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/customerAudienceTemplates HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudienceTemplates',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudienceTemplates',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/service/customerAudienceTemplates',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/service/customerAudienceTemplates', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudienceTemplates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/service/customerAudienceTemplates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of customer audience templates

GET https://api.apiture.com/service/customerAudienceTemplates

Return a collection of customer audience templates for the current analyst.

Parameters

Parameter	Description
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-f13a",
      "name": "High Balance Users in the Southeast",
      "description": "This template creates an audience with users who live in the southeast and have high account balances.",
      "customerType": "all",
      "enrollmentState": "enrolled",
      "filters": [
        {
          "operator": "and",
          "ordinal": 2,
          "primitiveFilters": [
            {
              "filterType": {
                "name": "customerRegion",
                "id": "01888d58e2424bf1c676"
              },
              "operator": "in",
              "values": [
                "NC",
                "SC",
                "GA",
                "FL"
              ],
              "ordinal": 0
            },
            {
              "filterType": {
                "name": "accountBalance",
                "id": "023cd8af6a9d46eec506"
              },
              "operator": "greaterThan",
              "values": [
                "250000.00"
              ],
              "ordinal": 1
            }
          ]
        }
      ],
      "topics": [
        {
          "id": "1cd2f01c-a9d9",
          "label": "Transaction Activity",
          "description": "View customer spending habits."
        }
      ],
      "customerCount": 12340,
      "retailCustomerCount": 10000,
      "commercialCustomerCount": 2340,
      "enrolledCustomerCount": 12300,
      "unenrolledCustomerCount": 40,
      "applicantCount": 100,
      "totalCustomerCount": 2340659,
      "ordinal": 0
    },
    {
      "id": "0399abed-f13b",
      "name": "Retirees in the Southeast",
      "description": "This template creates an audience with retail users whom are of retirement age.",
      "customerType": "retail",
      "enrollmentState": "enrolled",
      "filters": {
        "operator": "and",
        "ordinal": 0,
        "primitiveFilters": [
          {
            "filterType": {
              "name": "customerRegion",
              "id": "01888d58e2424bf1c676"
            },
            "operator": "in",
            "values": [
              "NC",
              "SC",
              "GA",
              "FL"
            ],
            "ordinal": 0
          },
          {
            "filterType": {
              "id": "6b3927745edec398ad76",
              "name": "customerAge"
            },
            "operator": "between",
            "values": [
              "65",
              "150"
            ],
            "ordinal": 1
          }
        ]
      },
      "topics": [
        {
          "id": "1cd2f01c-a9d0",
          "label": "Customer Demographics",
          "description": "See customer income, location, and other statistics."
        }
      ],
      "customerCount": 2222,
      "retailCustomerCount": 1222,
      "commercialCustomerCount": 1000,
      "enrolledCustomerCount": 2000,
      "unenrolledCustomerCount": 2222,
      "applicantCount": 100,
      "totalCustomerCount": 2341234,
      "ordinal": 1
    }
  ]
}

Responses

Status	Description
200	OK
	OK.
	Schema: `customerAudienceTemplates`

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getCustomerAudienceTemplate

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/service/customerAudienceTemplates/{customerAudienceTemplateId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/customerAudienceTemplates/{customerAudienceTemplateId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/customerAudienceTemplates/{customerAudienceTemplateId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/customerAudienceTemplates/{customerAudienceTemplateId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/service/customerAudienceTemplates/{customerAudienceTemplateId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/service/customerAudienceTemplates/{customerAudienceTemplateId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/customerAudienceTemplates/{customerAudienceTemplateId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/service/customerAudienceTemplates/{customerAudienceTemplateId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this customer audience template

GET https://api.apiture.com/service/customerAudienceTemplates/{customerAudienceTemplateId}

Return the JSON representation of this customer audience template resource.

Parameters

Parameter	Description
`customerAudienceTemplateId` `in: path`	`resourceId` (required) The unique identifier of this customer audience template. This is an opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`institutions` `in: query`	`array[string]` An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. `minItems: 1` `maxItems: 1` `pipe-delimited` items: `string` » `minLength: 2` » `maxLength: 8` » `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "id": "0399abed-f13a",
  "name": "High Balance Users in the Southeast",
  "description": "This template creates an audience with users who live in the southeast and have high account balances.",
  "customerType": "all",
  "enrollmentState": "enrolled",
  "filters": [
    {
      "operator": "and",
      "ordinal": 2,
      "primitiveFilters": [
        {
          "filterType": {
            "name": "customerRegion",
            "id": "01888d58e2424bf1c676"
          },
          "operator": "in",
          "values": [
            "NC",
            "SC",
            "GA",
            "FL"
          ],
          "ordinal": 0
        },
        {
          "filterType": {
            "name": "accountBalance",
            "id": "023cd8af6a9d46eec506"
          },
          "operator": "greaterThan",
          "values": [
            "250000.00"
          ],
          "ordinal": 1
        }
      ]
    }
  ],
  "topics": [
    {
      "id": "1cd2f01c-a9d9",
      "label": "Transaction Activity",
      "description": "View customer spending habits."
    }
  ],
  "ordinal": 0
}

Responses

Status	Description
200	OK
	OK.
	Schema: `customerAudienceTemplate`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such customer audience template resource at the specified `{customerAudienceId}`.
	Schema: `problemResponse`

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	`object` API problem or error response, as per RFC 9457 application/problem+json.
» type	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `maxLength: 2048`
» title	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `maxLength: 120`
» status	`integer(int32)` The HTTP status code for this occurrence of the problem. `minimum: 100` `maximum: 599`
» detail	`string(text)` A human-readable explanation specific to this occurrence of the problem. `maxLength: 256`
» instance	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `maxLength: 2048`
» id	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `minLength: 6` `maxLength: 48` pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `minLength: 20` `maxLength: 30`
» problems	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128`
» attributes	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Schemas

analyticFilterOperatorType

"equals"

Analytic Filter Operator Type (v1.0.0)

Indicates the type of the comparison operator used by an analytic filter.

analyticFilterOperatorType strings may have one of the following enumerated values:

Value	Description
`equals`	Equals: The measure is equal to a value. A filter using this operator requires exactly 1 value.
`notEquals`	Not Equals: The measure not equal to a value. A filter using this operator requires exactly 1 value.
`lessThan`	Less Than: The measurement less than a value. A filter using this operator requires exactly 1 value.
`lessThanOrEqualTo`	Less Than or Equal To: The measure less than or equal a value. A filter using this operator requires exactly 1 value.
`greaterThan`	Greater Than: The measure is greater than a value. A filter using this operator requires exactly 1 value.
`greaterThanOrEqualTo`	Greater Than or Equal To: The measure greater than or equal to a value. A filter using this operator requires exactly 1 value.
`between`	Between: The measure is Between a minimum and maximum value. A filter using this operator requires exactly 2 values.
`notBetween`	Not Between: Measure not between a minimum and maximum value. A filter using this operator requires exactly 2 values.
`before`	Before: Date measure before or on a value. A filter using this operator requires exactly 1 value.
`after`	After: Date measure on or after a value. A filter using this operator requires exactly 1 value.
`in`	In: The measure is in a set of values. A filter using this operator requires at least 2 values.
`notIn`	Not In: The measure is not in a set of values. A filter using this operator requires exactly 2 values.

type: string

enum values: equals, notEquals, lessThan, lessThanOrEqualTo, greaterThan, greaterThanOrEqualTo, before, after, between, notBetween, in, notIn

analyticFilterOrdinal

Analytic Filter Ordinal (v1.0.0)

An integer that represents this filter's importance relative to other filters, to allow the client to order filters by importance. This value may pertain to a primitive or composite filter. Filters with lower ordinal values are considered more important compared to those with higher values.

type: integer(int16)

format: int16
minimum: 0
maximum: 200

analyticFilterTypeName

"string"

Analytic Filter Type Name (v1.0.2)

The name of an analytic filter type.

type: string(text)

format: text
minLength: 2
maxLength: 100

analyticFilterTypeReference

{
  "id": "3752cfec9b06fae15c9e",
  "name": "customerAge"
}

Analytic Filter Type Reference (v1.0.2)

An object that reference and Analytic Filter Type by its id and name.

Properties

Name	Description
`Analytic Filter Type Reference (v1.0.2)`	`object` An object that reference and Analytic Filter Type by its `id` and `name`.
`id`	`resourceId` (required) The unique identifier for this analytic filter type resource. This is an immutable opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`name`	`analyticFilterTypeName(text)` The name of the filter type. This is for informational purposes only. `format: text` `minLength: 2` `maxLength: 100`

analyticFilterValue

"25-to-49"

Analytic Filter Value (v1.0.0)

A constant value used in a filter, such as 25 in a filter { customerAge greater than 25 }. This value is compared to the measure defined by the filter.

type: string(text)

format: text
maxLength: 200

apiProblem

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists at the given account_url",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

API Problem (v1.2.1)

API problem or error, as per RFC 7807 application/problem+json.

Properties

Name	Description
`API Problem (v1.2.1)`	`object` API problem or error, as per RFC 7807 application/problem+json.
`type`	`string(uri-reference)` A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`. `format: uri-reference` `maxLength: 2048`
`title`	`string(text)` A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`. `format: text` `maxLength: 120`
`status`	`integer(int32)` The HTTP status code for this occurrence of the problem. `format: int32` `minimum: 100` `maximum: 599`
`detail`	`string(text)` A human-readable explanation specific to this occurrence of the problem. `format: text` `maxLength: 256`
`instance`	`string(uri-reference)` A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment `format: uri-reference` `maxLength: 2048`
`id`	`readOnlyResourceId` The unique identifier for this problem. This is an immutable opaque string. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`occurredAt`	`readOnlyTimestamp(date-time)` The timestamp when the problem occurred, in RFC 3339 date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`problems`	`array: [apiProblem]` Optional root-causes if there are multiple problems in the request or API call processing. `maxItems: 128` items: `object`

campaignAudienceReference

{
  "id": "590c0c441f3241de9526",
  "name": "New Customers Ages 35-49"
}

Campaign Audience Reference (v1.1.0)

An object that references a Campaign Audience by its id and name.

Properties

Name	Description
`Campaign Audience Reference (v1.1.0)`	`object` An object that references a Campaign Audience by its `id` and `name`. `Unevaluated Properties: false`
`id`	`resourceId` (required) The unique identifier for this campaign audience resource. This is an immutable opaque string. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`name`	`string(text)` The audience name. `format: text` `maxLength: 100`

campaignReference

{
  "id": "0399abed-fd3d",
  "name": "Holiday Savings Campaign",
  "state": "active",
  "audience": {
    "id": "590c0c441f3241de9526",
    "name": "New Customers Ages 35-49"
  }
}

Campaign Reference (v1.3.0)

An object that references a summary of the campaign.

Properties

Name Description

Campaign Reference (v1.3.0) object
An object that references a summary of the campaign.

id resourceId (required)
The unique identifier for this campaign resource. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

name string(text) (required)
The campaign name.
format: text
minLength: 3
maxLength: 100

state

campaignState (required)

The set of states a campaign may have.

campaignState strings may have one of the following enumerated values:

Value	Description
`draft`	Draft: A campaign that is created but yet to be scheduled
`testing`	Testing: A campaign that is running for a specific audience for the purpose of testing before it is made public. Campaigns that have finished their tests move back to a draft or scheduled state when completed.
`scheduled`	Scheduled: A campaign that has been scheduled to be published on a set date but has not started running
`active`	Active: A running campaign. This includes a campaign that may or may not be displayed to end users due to scheduling
`paused`	Paused: An active campaign that is paused but may be resumed. No further ads are served from this campaign
`canceled`	Canceled: A campaign that has been canceled before the scheduled end date of the campaign
`completed`	Completed: A campaign that ran for its full schedule without being canceled
`archived`	Archived: A campaign that has been archived

enum values: draft, scheduled, testing, active, paused, canceled, completed, archived

audience campaignAudienceReference (required)
An object that references a Campaign Audience by its id and name.
Unevaluated Properties: false

campaignState

"draft"

Campaign States (v1.0.0)

The set of states a campaign may have.

campaignState strings may have one of the following enumerated values:

Value	Description
`draft`	Draft: A campaign that is created but yet to be scheduled
`testing`	Testing: A campaign that is running for a specific audience for the purpose of testing before it is made public. Campaigns that have finished their tests move back to a draft or scheduled state when completed.
`scheduled`	Scheduled: A campaign that has been scheduled to be published on a set date but has not started running
`active`	Active: A running campaign. This includes a campaign that may or may not be displayed to end users due to scheduling
`paused`	Paused: An active campaign that is paused but may be resumed. No further ads are served from this campaign
`canceled`	Canceled: A campaign that has been canceled before the scheduled end date of the campaign
`completed`	Completed: A campaign that ran for its full schedule without being canceled
`archived`	Archived: A campaign that has been archived

type: string

enum values: draft, scheduled, testing, active, paused, canceled, completed, archived

challengeFactor

{
  "type": "sms",
  "labels": [
    "9876"
  ]
}

Challenge Factor (v1.2.1)

A challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

Name Description

Challenge Factor (v1.2.1) object
A challenge factor. See requiredIdentityChallenge for multiple examples.

id

challengeFactorId
The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this id value as the factorId when starting or verifying a challenge factor.

Note: The id will become required in a future update to this schema.
minLength: 3
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{3,48}$"

type

challengeFactorType (required)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

Value	Description
`sms`	SMS: One-time passcode sent to the primary mobile phone number
`email`	Email: One-time passcode sent to the primary email address
`voice`	Voice: One-time passcode communicated via automated voice phone call
`authenticatorToken`	authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
`securityQuestions`	Security Questions: Prompt with the user's security questions registered with their security profile

enum values: sms, email, voice, securityQuestions, authenticatorToken

labels array: [string]
A list of text label which identifies the channel(s) through which the user completes the challenge. For an sms or voice challenge, the only label item is the last four digits of the corresponding phone number. For an email challenge, each label is the masked email address.
minItems: 1
maxItems: 4
items: string(text)
» format: text
» maxLength: 300

securityQuestions challengeSecurityQuestions
Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

challengeFactorId

"string"

Challenge Factor ID (v1.0.0)

The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.

type: string

minLength: 3
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{3,48}$"

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

Value	Description
`sms`	SMS: One-time passcode sent to the primary mobile phone number
`email`	Email: One-time passcode sent to the primary email address
`voice`	Voice: One-time passcode communicated via automated voice phone call
`authenticatorToken`	authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
`securityQuestions`	Security Questions: Prompt with the user's security questions registered with their security profile

type: string

enum values: sms, email, voice, securityQuestions, authenticatorToken

challengeOperationId

"string"

Challenge Operation ID (v1.0.1)

The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.

type: string

minLength: 6
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{6,48}$"

challengePromptId

"string"

Challenge Prompt ID (v1.0.0)

The unique ID of a prompt (such as a security question) in a challenge factor.

type: string

minLength: 1
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]+$"

challengeSecurityQuestion

{
  "id": "74699fa628911e762ea5",
  "prompt": "What is your mother's maiden name?"
}

Challenge Security Question (v1.0.1)

A single security question within the questions array of the challengeSecurityQuestions

Properties

Name	Description
`Challenge Security Question (v1.0.1)`	`object` A single security question within the `questions` array of the `challengeSecurityQuestions`
`id`	`challengePromptId` (required) The unique ID of security question prompt. This should be included in the `challengeVerification` response as the `promptId`. `minLength: 1` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]+$"`
`prompt`	`string(text)` (required) The text prompt of this security question. `format: text` `maxLength: 80`

challengeSecurityQuestions

{
  "questions": [
    {
      "id": "q1",
      "prompt": "What is your mother's maiden name?"
    },
    {
      "id": "q4",
      "prompt": "What is your high school's name?"
    },
    {
      "id": "q9",
      "prompt": "What is the name of your first pet?"
    }
  ]
}

Challenge Security Questions (v1.0.1)

Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

Properties

Name	Description
`Challenge Security Questions (v1.0.1)`	`object` Describes a `securityQuestions` challenge. This is omitted if the challenge `type` is not `securityQuestions`.
`questions`	`array: [challengeSecurityQuestion]` (required) The array of security questions. `minItems: 1` `maxItems: 8` items: `object`

compositeAnalyticFilter

{
  "operator": "or",
  "primitiveFilters": [
    {
      "filterType": {
        "id": "215eaed841368ce154d5",
        "name": "customerType"
      },
      "operator": "equals",
      "values": [
        "retail"
      ],
      "ordinal": 0,
      "includeMissingValues": false
    },
    {
      "filterType": {
        "id": "6b3927745edec398ad74",
        "name": "customerAge"
      },
      "operator": "between",
      "values": [
        "35",
        "49"
      ],
      "ordinal": 1,
      "includeMissingValues": false
    }
  ],
  "compositeFilters": [
    {
      "operator": "and",
      "ordinal": 2,
      "primitiveFilters": [
        {
          "filterType": {
            "name": "customerRegion",
            "id": "01888d58e2424bf1c676"
          },
          "operator": "in",
          "values": [
            "NC",
            "SC",
            "GA",
            "FL"
          ],
          "ordinal": 0,
          "includeMissingValues": false
        },
        {
          "filterType": {
            "name": "accountBalance",
            "id": "023cd8af6a9d46eec506"
          },
          "operator": "greaterThan",
          "values": [
            "250000.00"
          ],
          "ordinal": 1,
          "includeMissingValues": false
        }
      ]
    }
  ]
}

Composite Analytic Filter (v2.1.0)

A composite of analytic filter that are combined with a logical operator (and, or, not). For example, if primitiveFilters contains 3 filters p1, p2 and p2 and compositeFilters contains 2 filters c1, c2 and operator is and, the filter represents the expression ( p1 and p2 and p3 and c1 and c2 ). The example is equivalent to

( { customerType equals "retail" } or { customerAge between ["35", "49"] } or ( { customerRegion in [ "NC", "SC", "GA", "FL" ]} and { balance greaterThan "250000.00" } ) )

Note: there must be at least one item in either the primitiveFilters array or the compositeFilters array.

Properties

Name	Description
`Composite Analytic Filter (v2.1.0)`	`object` A composite of analytic filter that are combined with a logical operator (`and`, `or`, `not`). For example, if `primitiveFilters` contains 3 filters `p1`, `p2` and `p2` and `compositeFilters` contains 2 filters `c1`, `c2` and `operator` is `and`, the filter represents the expression `( p1 and p2 and p3 and c1 and c2 )`. The example is equivalent to `( { customerType equals "retail" } or { customerAge between ["35", "49"] } or ( { customerRegion in [ "NC", "SC", "GA", "FL" ]} and { balance greaterThan "250000.00" } ) )` Note: there must be at least one item in either the `primitiveFilters` array or the `compositeFilters` array.
`operator`	`compositeFilterOperator` The logical operator (and, or, not) used to combine the contained filters. enum values: `and`, `or`, `not`
`primitiveFilters`	`array: [primitiveAnalyticFilter]` An array of 1 or more primitive filters to be combined via the `operator` with each other and the `compositeFilters`. `minItems: 1` `maxItems: 100` items: `object`
`compositeFilters`	`array: [compositeAnalyticFilter]` An array of 0 or more composite filters to be combined via the `operator` with each other and the `primitiveFilters`. `maxItems: 100` items: `object`

compositeFilterOperator

"and"

Composite Filter Operator (v1.0.0)

An operator for combining filters in a composite filter.

compositeFilterOperator strings may have one of the following enumerated values:

Value	Description
`and`	And: A filter is true if all the nested filters evaluate to true.
`or`	Or: A filter is true if any one or more of the nested filters evaluate to true.
`not`	Not: A filter is true if none of the nested filters evaluate to true.

type: string

enum values: and, or, not

customerAudience

{
  "name": "Most valuable customers",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled",
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "owners": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ],
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ],
  "connections": [
    {
      "id": "0399abed-fd3d",
      "state": "active",
      "provider": {
        "name": "pendo",
        "resourceId": "q6PioQIWPFAhOA"
      }
    }
  ],
  "identifierType": "customerId",
  "includesHeader": true
}

Customer Audience (v7.7.0)

Representation of customer audience resources.

Properties

Name Description

Customer Audience (v7.7.0) object
Representation of customer audience resources.

createdAt readOnlyTimestamp(date-time) (required)
The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.
read-only
format: date-time
minLength: 20
maxLength: 30

updatedAt readOnlyTimestamp(date-time) (required)
The date-time when the resource was last updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.
read-only
format: date-time
minLength: 20
maxLength: 30

name string(text)
The name of this audience.
format: text
minLength: 3
maxLength: 100

description string(text)
A detailed description of the audience.
format: text
minLength: 3
maxLength: 256

customerType customerAudienceCustomerType
When used with the filter customer audience source, the customer type to use as the primary customer filter. This is implicitly combined with the other filters with an and operator. The default is all. When used with a list or insight customer audience source, the customer type is derived based on the audience customers.
enum values: all, retail, commercial

enrollmentState customerAudienceEnrollmentState
When used with the filter customer audience source, the enrollment state to use as the primary enrollment filter. This is implicitly combined with the other filters with an and operator. The default is customer. When used with a list or insight customer audience source, this is the enrollment state used as the primary enrollment state filter.
enum values: all, customer, enrolled, unenrolled, applicant

filters compositeAnalyticFilter
One or more customer audiences filters that are combined with a logical operator (and, or, not). Note that the customer type filter is implicitly defined with the customerType property of the audience resource (it is also automatically combined with these filters with an and), so these filters should not include a customer type filter.

id readOnlyResourceId (required)
The unique identifier for this customer audience resource. This is an immutable opaque string.
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

state

customerAudienceState (required)

The state of a Customer Audience

customerAudienceState strings may have one of the following enumerated values:

Value	Description
`active`	Active: The audience is active and available for use.
`archived`	Archived: The audience is archived and not available for use. Archived audiences are deleted 30 days after being archived.

enum values: active, archived

owners array: [customerAudienceOwner] (required)
The analysts who own this customer audience.
minItems: 1
maxItems: 1
items: object

connections array: [customerAudienceConnectionReference]
A list of customer audience connections that are tied to this audience.
maxItems: 1000
items: object

updatedBy customerAudienceCollaborator
The analyst who last updated this customer audience.

source customerAudienceSource (required)
The source used to create this audience.
enum values: filter, insight, list, template, campaign

insight insightReference
A summary of the insight that was used to create this audience. This field is omitted if the audience was not created from an insight.

template customerAudienceTemplateReference
A summary of the audience template that was used to create this audience. This field is omitted if the audience was not created from a template.

fileName customerAudienceFileName(text)
The name of the file used to create this audience. This is available when the audience source is list.
format: text
minLength: 4
maxLength: 255

identifierType

customerAudienceImportIdentifierType

The type of the field used for importing customer audience customers.

customerAudienceImportIdentifierType strings may have one of the following enumerated values:

Value	Description
`username`	Username: The import contains the login usernames of financial institution customers
`customerId`	Customer ID: The import contains the customer IDs of financial institution customers
`dataCustomerId`	Data Customer ID: The import contains the data customer IDs of financial institution customers
`taxIdNumber`	Tax ID Number: The import contains the tax identifiers of financial institution customers, such as social security number (SSN) or employer identification number (EIN)

enum values: username, customerId, dataCustomerId, taxIdNumber

includesHeader boolean
Indicates whether the customer audience IDs file included a header row or not.

campaign campaignReference
A summary of the campaign whose engagement data was used to create this audience. This field is omitted if the audience was not created from a campaign.

customerCount integer(int32) (required)
The number of customers who match this audience's filter criteria.
format: int32
minimum: 0
maximum: 1000000000

retailCustomerCount integer(int32)
The number of retail customers who match this audience's filter criteria.
format: int32
minimum: 0
maximum: 1000000000

commercialCustomerCount integer(int32)
The number of commercial customers who match this audience's filter criteria.
format: int32
minimum: 0
maximum: 1000000000

enrolledCustomerCount integer(int32)
The number of customers who are enrolled in online banking and match this audience's filter criteria.
format: int32
minimum: 0
maximum: 1000000000

unenrolledCustomerCount integer(int32)
The number of customers who are not enrolled in online banking and match this audience's filter criteria.
format: int32
minimum: 0
maximum: 1000000000

applicantCount integer(int32)
The number of digital banking applicants who match this audience's filter criteria.
format: int32
minimum: 0
maximum: 1000000000

totalCustomerCount integer(int32) (required)
The total number of customers at the financial institution, ignoring any filter criteria.
format: int32
minimum: 0
maximum: 1000000000

customerCountUpdatedAt timestamp(date-time) (required)
The timestamp when the customerCount was last updated, in RFC 3339 UTC YYYY-MM-DDThh:mm:ss.sssZ date-time format.
format: date-time
minLength: 20
maxLength: 30

collaborators array: [customerAudienceCollaborator] (required)
An array containing customer audience collaborators. Update this value with the patchCustomerAudienceCollaborators operation.
read-only
maxItems: 2000
items: object

customerAudienceCollaborator

{
  "id": "0399abedfd3d",
  "firstName": "Bob",
  "lastName": "Hartley",
  "username": "bhartley"
}

Customer Audience Collaborator (v2.0.1)

A collaborator that a customer audience resource has been shared with. This customer audience appears in the listCustomerAudiences response for each collaborator, and their allows object will determine what operations the collaborator may use.

Properties

Name	Description
`Customer Audience Collaborator (v2.0.1)`	`object` A collaborator that a customer audience resource has been shared with. This customer audience appears in the `listCustomerAudiences` response for each collaborator, and their `allows` object will determine what operations the collaborator may use.
`id`	`resourceId` (required) The immutable, unique, opaque identifier for the user. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`firstName`	`string(text)` (required) The user's first name. `format: text` `maxLength: 56`
`lastName`	`string(text)` (required) The user's last name. `format: text` `maxLength: 56`
`username`	`customerUsername(text)` (required) The user's login name. `format: text` `minLength: 5` `maxLength: 128`

customerAudienceCollaborators

{
  "owners": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ],
  "items": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ]
}

Customer Audience Collaborators (v3.0.0)

A list of collaborators that this audience resource has been shared with. Manage collaborators with the patchCustomerAudienceCollaborator operation.

Properties

Name	Description
`Customer Audience Collaborators (v3.0.0)`	`object` A list of collaborators that this audience resource has been shared with. Manage collaborators with the `patchCustomerAudienceCollaborator` operation.
`owners`	`array: [customerAudienceOwner]` (required) An array containing the owners of this customer audience. `minItems: 1` `maxItems: 1` items: `object`
`items`	`array: [customerAudienceCollaborator]` (required) An array containing customer audience collaborator items. `maxItems: 2000` items: `object`

customerAudienceConnectionProvider

{
  "name": "string",
  "connectedResourceId": "string"
}

Customer Audience Connection Provider (v1.0.0)

Properties that are specific to the audience connection's provider for an institution.

Properties

Name	Description
`Customer Audience Connection Provider (v1.0.0)`	`object` Properties that are specific to the audience connection's provider for an institution.
`name`	`string(text)` The audience connection provider name. `format: text` `maxLength: 80`
`connectedResourceId`	`externalResourceId(text)` A value that uniquely identifies the resource associated with the audience in the connected provider. `read-only` `format: text` `minLength: 1` `maxLength: 256`

customerAudienceConnectionReference

{
  "id": "0399abed-fd3d",
  "state": "active",
  "provider": {
    "name": "pendo",
    "resourceId": "q6PioQIWPFAhOA"
  }
}

Customer Audience Connection Reference (v1.0.0)

An object that references a customer audience connection by its id, provider, and state.

Properties

Name Description

Customer Audience Connection Reference (v1.0.0) object
An object that references a customer audience connection by its id, provider, and state.

id resourceId (required)
The unique identifier for this customer audience connection resource. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

provider customerAudienceConnectionProvider (required)
Properties that pertain to the audience connection provider.

state

customerAudienceConnectionState (required)

The state of a customer audience connection

customerAudienceConnectionState strings may have one of the following enumerated values:

Value	Description
`active`	Active: The audience connection is active and available for use.
`inactive`	Inactive: The audience connection is inactive. The connection must be reactivated before it can be used.
`pending`	Pending: The audience connection is pending and not yet available for use.
`failed`	Failed: The audience connection failed. Activate the connection to retry connecting.

enum values: active, inactive, pending, failed

customerAudienceConnectionState

"active"

Customer Audience Connection State (v1.0.0)

The state of a customer audience connection

customerAudienceConnectionState strings may have one of the following enumerated values:

Value	Description
`active`	Active: The audience connection is active and available for use.
`inactive`	Inactive: The audience connection is inactive. The connection must be reactivated before it can be used.
`pending`	Pending: The audience connection is pending and not yet available for use.
`failed`	Failed: The audience connection failed. Activate the connection to retry connecting.

type: string

enum values: active, inactive, pending, failed

customerAudienceCounts

{
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
}

Customer Audience Counts (v1.1.0)

The count of customers who meet the criteria of the given customer audience filters or insight.

Properties

Name	Description
`Customer Audience Counts (v1.1.0)`	`object` The count of customers who meet the criteria of the given customer audience filters or insight.
`customerCount`	`integer(int32)` (required) The number of customers who match this audience's filter criteria. `format: int32` `minimum: 0` `maximum: 1000000000`
`retailCustomerCount`	`integer(int32)` The number of retail customers who match this audience's filter criteria. `format: int32` `minimum: 0` `maximum: 1000000000`
`commercialCustomerCount`	`integer(int32)` The number of commercial customers who match this audience's filter criteria. `format: int32` `minimum: 0` `maximum: 1000000000`
`enrolledCustomerCount`	`integer(int32)` The number of customers who are enrolled in online banking and match this audience's filter criteria. `format: int32` `minimum: 0` `maximum: 1000000000`
`unenrolledCustomerCount`	`integer(int32)` The number of customers who are not enrolled in online banking and match this audience's filter criteria. `format: int32` `minimum: 0` `maximum: 1000000000`
`applicantCount`	`integer(int32)` The number of digital banking applicants who match this audience's filter criteria. `format: int32` `minimum: 0` `maximum: 1000000000`
`totalCustomerCount`	`integer(int32)` (required) The total number of customers at the financial institution, ignoring any filter criteria. `format: int32` `minimum: 0` `maximum: 1000000000`
`customerCountUpdatedAt`	`timestamp(date-time)` (required) The timestamp when the `customerCount` was last updated, in RFC 3339 UTC `YYYY-MM-DDThh:mm:ss.sssZ` date-time format. `format: date-time` `minLength: 20` `maxLength: 30`

customerAudienceCountsRequest

{
  "operator": "or",
  "primitiveFilters": [
    {
      "filterType": {
        "id": "215eaed841368ce154d5",
        "name": "customerType"
      },
      "operator": "equals",
      "values": [
        "retail"
      ],
      "ordinal": 0,
      "includeMissingValues": false
    },
    {
      "filterType": {
        "id": "6b3927745edec398ad74",
        "name": "customerAge"
      },
      "operator": "between",
      "values": [
        "35",
        "49"
      ],
      "ordinal": 1,
      "includeMissingValues": false
    }
  ],
  "compositeFilters": [
    {
      "operator": "and",
      "ordinal": 2,
      "primitiveFilters": [
        {
          "filterType": {
            "name": "customerRegion",
            "id": "01888d58e2424bf1c676"
          },
          "operator": "in",
          "values": [
            "NC",
            "SC",
            "GA",
            "FL"
          ],
          "ordinal": 0,
          "includeMissingValues": false
        },
        {
          "filterType": {
            "name": "accountBalance",
            "id": "023cd8af6a9d46eec506"
          },
          "operator": "greaterThan",
          "values": [
            "250000.00"
          ],
          "ordinal": 1,
          "includeMissingValues": false
        }
      ]
    }
  ]
}

Customer Audience Counts Request (v1.0.0)

Schema representation used to request a count of members in a customer audience.

Properties

Name	Description
`Customer Audience Counts Request (v1.0.0)`	`object` Schema representation used to request a count of members in a customer audience.
`operator`	`compositeFilterOperator` The logical operator (and, or, not) used to combine the contained filters. enum values: `and`, `or`, `not`
`primitiveFilters`	`array: [primitiveAnalyticFilter]` An array of 1 or more primitive filters to be combined via the `operator` with each other and the `compositeFilters`. `minItems: 1` `maxItems: 100` items: `object`
`compositeFilters`	`array: [compositeAnalyticFilter]` An array of 0 or more composite filters to be combined via the `operator` with each other and the `primitiveFilters`. `maxItems: 100` items: `object`
`ordinal`	`analyticFilterOrdinal(int16)` The ordinal value of the composite filter. `format: int16` `minimum: 0` `maximum: 200`
`insightId`	`readOnlyResourceId` The ID of the insight resource that this audience was derived from. This field is omitted if the audience was not created from an insight. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

customerAudienceCustomerItem

{
  "dataCustomerId": "d884eab0082669f519b0",
  "customerId": "9dfb049f5672424d7b3b",
  "primaryPhoneNumber": "+19992345678",
  "primaryEmail": "email@example.com"
}

Customer Audience Customer Item (v1.1.0)

Customer data, including the customerId and dataCustomerId, for a person at the financial institution. If the person is not a digital banking customer at the financial institution, then customerId is omitted.

Properties

Name	Description
`Customer Audience Customer Item (v1.1.0)`	`object` Customer data, including the `customerId` and `dataCustomerId`, for a person at the financial institution. If the person is not a digital banking customer at the financial institution, then `customerId` is omitted.
`dataCustomerId`	`string` (required) The ID of the customer in data systems. `minLength: 1` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`customerId`	`resourceId` The ID of the digital banking customer. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`primaryPhoneNumber`	`extendedPhoneNumber(extended-phone-number)` The primary phone number of the customer. `format: extended-phone-number` `minLength: 5` `maxLength: 20`
`primaryEmail`	`string(email)` The primary email address of the customer. `format: email` `maxLength: 255`

customerAudienceCustomerType

"all"

Customer Audience Customer Type (v1.0.0)

Selects the customer type to use as the primary customer filter.

customerAudienceCustomerType strings may have one of the following enumerated values:

Value	Description
`all`	All Customers: All customers/members at the financial institution
`retail`	Retail Customers: Retail (personal) banking customers/members at the financial institution
`commercial`	Commercial Customers: Commercial (business) banking customers/members at the financial institution

type: string

enum values: all, retail, commercial

customerAudienceCustomers

{
  "count": 189,
  "items": [
    {
      "dataCustomerId": "9dfb049f5672424d7b3b",
      "customerId": "d884eab0082669f519b0",
      "primaryPhoneNumber": "+19992345678",
      "primaryEmail": "email@example.com"
    },
    {
      "dataCustomerId": "f26c043c527f42430b15",
      "customerId": "c3aadd481d5301b568e6",
      "primaryPhoneNumber": "+11112345678",
      "primaryEmail": "api@example.com"
    },
    {
      "dataCustomerId": "40ce35bd15417a2e2a09",
      "customerId": "63d87c56c86fc231f20f"
    },
    {
      "dataCustomerId": "c84fd4b81049c27d4a65",
      "customerId": "936a1b266f88066d9c97"
    },
    {
      "dataCustomerId": "b8e93bb1bd22dba4093c",
      "customerId": "80f3a986ab155a4e740e"
    },
    {
      "dataCustomerId": "c5247e8f5de1a4e79f67",
      "customerId": "514434dfd748d66f506c"
    },
    {
      "dataCustomerId": "5e979274f87e41eee739",
      "customerId": "4b6b478295c150ae7a7e"
    },
    {
      "dataCustomerId": "6dc7c36cb2306288919f",
      "customerId": "f31508460b6329cc6f9a"
    },
    {
      "dataCustomerId": "09c8fdf03607d0e12c91"
    },
    {
      "dataCustomerId": "c50aae5d1be0ad19ca5b"
    }
  ],
  "nextPage_url": "https://production.api.apiture.com/bankingAdmin/customerAudiences/0399abedfd3d/customers?start=74f96e77c3aafcb9fe85?limit=10"
}

Customer Audience Customers (v2.1.0)

A page of customer data for an audience.

Properties

Name	Description
`Customer Audience Customers (v2.1.0)`	`object` A page of customer data for an audience.
`items`	`array: [customerAudienceCustomerItem]` The array of customer data. `maxItems: 100000` items: `object`
`count`	`integer(int32)` The total number of customers which satisfy this audience's filter criteria. `format: int32` `minimum: 0` `maximum: 1000000000`
`nextPage_url`	`string(uri-reference)` The URL of the next page of customer data. If this URL is omitted, there are no more customer data. `read-only` `format: uri-reference` `maxLength: 256`

customerAudienceCustomersImport

{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "fileName": "2023_18to35_north_carolina.csv"
}

Customer Audience Import (v1.3.0)

A request to import a values file of customers for a customer audience.

Properties

Name Description

Customer Audience Import (v1.3.0) object
A request to import a values file of customers for a customer audience.

identifierType

customerAudienceImportIdentifierType (required)

The type of the field used for importing customer audience customers.

customerAudienceImportIdentifierType strings may have one of the following enumerated values:

Value	Description
`username`	Username: The import contains the login usernames of financial institution customers
`customerId`	Customer ID: The import contains the customer IDs of financial institution customers
`dataCustomerId`	Data Customer ID: The import contains the data customer IDs of financial institution customers
`taxIdNumber`	Tax ID Number: The import contains the tax identifiers of financial institution customers, such as social security number (SSN) or employer identification number (EIN)

enum values: username, customerId, dataCustomerId, taxIdNumber

includesHeader boolean (required)
Indicates whether the customer audience IDs file includes a header row or not.

fileName customerAudienceFileName(text)
The name of the file used to create this audience. This is available when the audience source is list.
format: text
minLength: 4
maxLength: 255

content

string(byte) (required)
The Base64-encoded content containing the identifiers for customers to include in a customer audience.

The import allows comma-separated values (CSV), plain text, and Microsoft Excel (.xls and .xlsx format) files.

The maximum length constraint allows for a (non-Base64 encoded) input file of at most 6,500,000 bytes.
format: byte
maxLength: 8905000

customerAudienceEnrollmentState

"all"

Customer Audience Enrollment State (v1.1.0)

Selects the enrollment state to use as the primary customer enrollment state filter.

customerAudienceEnrollmentState strings may have one of the following enumerated values:

Value	Description
`all`	All: Includes all banking customers and applicants.
`customer`	Customer: Includes enrolled and unenrolled banking customers (retail and commercial).
`enrolled`	Enrolled: Users that are enrolled for online banking at the financial institution.
`unenrolled`	Unenrolled: Users that are not enrolled for online banking at the financial institution.
`applicant`	applicant: An entity or entities that are in the process of applying for a digital account, but are not yet customers at the financial institution.

type: string

enum values: all, customer, enrolled, unenrolled, applicant

customerAudienceFileName

"2023_18to35_north_carolina.csv"

Customer Audience File Name (v1.0.0)

The name of the file used to create this audience. This is available when the audience source is list.

type: string(text)

format: text
minLength: 4
maxLength: 255

customerAudienceImport

{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "fileName": "2023_18to35_north_carolina.csv"
}

Customer Audience Import (v2.2.0)

A request to create a new customer audience from a file of customer audience IDs.

Properties

Name Description

Customer Audience Import (v2.2.0) object
A request to create a new customer audience from a file of customer audience IDs.

name string(text) (required)
The name of this audience.
format: text
minLength: 3
maxLength: 100

description string(text)
A detailed description of the audience.
format: text
minLength: 3
maxLength: 256

identifierType

customerAudienceImportIdentifierType (required)

The type of the field used for importing customer audience customers.

customerAudienceImportIdentifierType strings may have one of the following enumerated values:

Value	Description
`username`	Username: The import contains the login usernames of financial institution customers
`customerId`	Customer ID: The import contains the customer IDs of financial institution customers
`dataCustomerId`	Data Customer ID: The import contains the data customer IDs of financial institution customers
`taxIdNumber`	Tax ID Number: The import contains the tax identifiers of financial institution customers, such as social security number (SSN) or employer identification number (EIN)

enum values: username, customerId, dataCustomerId, taxIdNumber

includesHeader boolean (required)
Indicates whether the customer audience IDs file includes a header row or not.

fileName customerAudienceFileName(text) (required)
The name of the file used to create this audience. This is available when the audience source is list.
format: text
minLength: 4
maxLength: 255

content

string(byte) (required)
The Base64-encoded content containing the identifiers for customers to include in a customer audience.

The import allows comma-separated values (CSV), plain text, and Microsoft Excel (.xls and .xlsx format) files.

The maximum length constraint allows for a (non-Base64 encoded) input file of at most 6,500,000 bytes.
format: byte
maxLength: 8905000

customerAudienceImportIdentifierType

"username"

Customer Audience Import Identifier Type (v1.1.0)

The type of the field used for importing customer audience customers.

customerAudienceImportIdentifierType strings may have one of the following enumerated values:

Value	Description
`username`	Username: The import contains the login usernames of financial institution customers
`customerId`	Customer ID: The import contains the customer IDs of financial institution customers
`dataCustomerId`	Data Customer ID: The import contains the data customer IDs of financial institution customers
`taxIdNumber`	Tax ID Number: The import contains the tax identifiers of financial institution customers, such as social security number (SSN) or employer identification number (EIN)

type: string

enum values: username, customerId, dataCustomerId, taxIdNumber

customerAudienceItem

{
  "name": "Most valuable customers",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "enrollmentState": "enrolled",
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "owners": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    }
  ],
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ],
  "connections": [
    {
      "id": "0399abed-fd3d",
      "state": "active",
      "provider": {
        "name": "pendo",
        "resourceId": "q6PioQIWPFAhOA"
      }
    }
  ],
  "identifierType": "customerId",
  "includesHeader": true
}

Customer Audience Item (v7.7.0)

Summary representation of a customer audience resource in the customer audiences collection. To fetch the full representation of this customer audience, use the getCustomerAudience operation, passing this item's id field as the customerAudienceId path parameter.

Properties

Name Description

Customer Audience Item (v7.7.0) object
Summary representation of a customer audience resource in the customer audiences collection. To fetch the full representation of this customer audience, use the getCustomerAudience operation, passing this item's id field as the customerAudienceId path parameter.

name string(text)
The name of this audience.
format: text
minLength: 3
maxLength: 100

description string(text)
A detailed description of the audience.
format: text
minLength: 3
maxLength: 256

filters

compositeAnalyticFilter
A composite of analytic filter that are combined with a logical operator (and, or, not). For example, if primitiveFilters contains 3 filters p1, p2 and p2 and compositeFilters contains 2 filters c1, c2 and operator is and, the filter represents the expression ( p1 and p2 and p3 and c1 and c2 ). The example is equivalent to

( { customerType equals "retail" } or { customerAge between ["35", "49"] } or ( { customerRegion in [ "NC", "SC", "GA", "FL" ]} and { balance greaterThan "250000.00" } ) )

Note: there must be at least one item in either the primitiveFilters array or the compositeFilters array.

state

customerAudienceState (required)

The state of a Customer Audience

customerAudienceState strings may have one of the following enumerated values:

Value	Description
`active`	Active: The audience is active and available for use.
`archived`	Archived: The audience is archived and not available for use. Archived audiences are deleted 30 days after being archived.

enum values: active, archived

owners array: [customerAudienceOwner] (required)
The analysts who own this customer audience.
minItems: 1
maxItems: 1
items: object

connections array: [customerAudienceConnectionReference]
A list of customer audience connections that are tied to this audience.
maxItems: 1000
items: object

updatedBy customerAudienceCollaborator
The analyst who last updated this customer audience.

source customerAudienceSource (required)
The source used to create this audience.
enum values: filter, insight, list, template, campaign

insight insightReference
A summary of the insight that was used to create this audience. This field is omitted if the audience was not created from an insight.

template customerAudienceTemplateReference
A summary of the audience template that was used to create this audience. This field is omitted if the audience was not created from a template.

fileName customerAudienceFileName(text)
The name of the file used to create this audience. This is available when the audience source is list.
format: text
minLength: 4
maxLength: 255

identifierType

customerAudienceImportIdentifierType

The type of the field used for importing customer audience customers.

customerAudienceImportIdentifierType strings may have one of the following enumerated values:

Value	Description
`username`	Username: The import contains the login usernames of financial institution customers
`customerId`	Customer ID: The import contains the customer IDs of financial institution customers
`dataCustomerId`	Data Customer ID: The import contains the data customer IDs of financial institution customers
`taxIdNumber`	Tax ID Number: The import contains the tax identifiers of financial institution customers, such as social security number (SSN) or employer identification number (EIN)