Meta Custom Audiences

App · 12 actions

Create customer-list audiences, add or remove members, and manage audience sharing.

Actions

ActionWhat it does
Add membersAdd members in Meta Custom Audiences.
Create audienceCreate audience in Meta Custom Audiences.
Delete audienceDelete audience in Meta Custom Audiences.
Get ad accountGet ad account in Meta Custom Audiences.
Get audienceGet audience in Meta Custom Audiences.
List ad accountsList ad accounts in Meta Custom Audiences.
List audiencesList audiences in Meta Custom Audiences.
List shared accountsList shared accounts in Meta Custom Audiences.
Remove membersRemove members in Meta Custom Audiences.
Share audienceShare audience in Meta Custom Audiences.
Unshare audienceUnshare audience in Meta Custom Audiences.
Update audienceUpdate audience in Meta Custom Audiences.

Add members

Add members in Meta Custom Audiences.

Inputs

Audienceaudience_idtextRequired
Audience ID.
Identifier typeidentifier_typetextRequired
Identifier type.One of: EMAIL, PHONE.
IdentifiersidentifierslistRequired
Identifiers.

Outputs

dataobject
Meta Custom Audiences response data.
Example output
{
  "data": {
    "audience_id": "example",
    "num_invalid_entries": 1,
    "num_received": 1,
    "session_id": "example"
  }
}

Create audience

Create audience in Meta Custom Audiences.

Inputs

Ad accountad_account_idtextRequired
Ad account ID.
NamenametextRequired
Name.
Descriptiondescriptiontext
Description.
Customer file sourcecustomer_file_sourcetextRequired
Customer file source.One of: USER_PROVIDED_ONLY (User provided only), PARTNER_PROVIDED_ONLY (Partner provided only), BOTH_USER_AND_PARTNER_PROVIDED (Both user and partner provided).
Retention daysretention_daysnumber
Retention days.From 1 to 180.

Outputs

dataobject
Meta Custom Audiences response data.
Example output
{
  "data": {
    "id": "example"
  }
}

Delete audience

Delete audience in Meta Custom Audiences.

Inputs

Audienceaudience_idtextRequired
Audience ID.

Outputs

dataobject
Meta Custom Audiences response data.
Example output
{
  "data": {
    "success": false
  }
}

Get ad account

Get ad account in Meta Custom Audiences.

Inputs

Ad accountad_account_idtextRequired
Ad account ID.

Outputs

dataobject
Meta Custom Audiences response data.
Example output
{
  "data": {
    "account_id": "example",
    "id": "example",
    "name": "example"
  }
}

Get audience

Get audience in Meta Custom Audiences.

Inputs

Audienceaudience_idtextRequired
Audience ID.

Outputs

dataobject
Meta Custom Audiences response data.
Example output
{
  "data": {
    "delivery_status": {},
    "description": "example",
    "id": "example",
    "name": "example",
    "operation_status": {},
    "subtype": "example",
    "time_updated": 1
  }
}

List ad accounts

List ad accounts in Meta Custom Audiences.

Inputs

Afteraftertext
After.
Limitlimitnumber
Limit.From 1 to 100.

Outputs

dataobject
Meta Custom Audiences response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "data": [],
    "paging": {}
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List audiences

List audiences in Meta Custom Audiences.

Inputs

Ad accountad_account_idtextRequired
Ad account ID.
Afteraftertext
After.
Limitlimitnumber
Limit.From 1 to 100.

Outputs

dataobject
Meta Custom Audiences response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "data": [],
    "paging": {}
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List shared accounts

List shared accounts in Meta Custom Audiences.

Inputs

Audienceaudience_idtextRequired
Audience ID.
Afteraftertext
After.
Limitlimitnumber
Limit.From 1 to 100.
Permissionspermissionstext
Permissions.One of: targeting, targeting_and_insights (Targeting and insights).

Outputs

dataobject
Meta Custom Audiences response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "data": [],
    "paging": {}
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Remove members

Remove members in Meta Custom Audiences.

Inputs

Audienceaudience_idtextRequired
Audience ID.
Identifier typeidentifier_typetextRequired
Identifier type.One of: EMAIL, PHONE.
IdentifiersidentifierslistRequired
Identifiers.

Outputs

dataobject
Meta Custom Audiences response data.
Example output
{
  "data": {
    "audience_id": "example",
    "num_invalid_entries": 1,
    "num_received": 1,
    "session_id": "example"
  }
}

Share audience

Share audience in Meta Custom Audiences.

Inputs

Audienceaudience_idtextRequired
Audience ID.
Ad accountsad_accountslistRequired
Ad accounts.
Permissionspermissionstext
Permissions.One of: targeting, targeting_and_insights (Targeting and insights).

Outputs

dataobject
Meta Custom Audiences response data.
Example output
{
  "data": {
    "success": false
  }
}

Unshare audience

Unshare audience in Meta Custom Audiences.

Inputs

Audienceaudience_idtextRequired
Audience ID.
Ad accountsad_accountslistRequired
Ad accounts.

Outputs

dataobject
Meta Custom Audiences response data.
Example output
{
  "data": {
    "success": false
  }
}

Update audience

Update audience in Meta Custom Audiences.

Inputs

Audienceaudience_idtextRequired
Audience ID.
Namenametext
Name.
Descriptiondescriptiontext
Description.

Outputs

dataobject
Meta Custom Audiences response data.
Example output
{
  "data": {
    "success": false
  }
}

On this page