Sign in

v1

latestOpenAPI 3.1.12026-07-14355311.4 MB
TargetList

Create TargetList

Create a new 'TargetList' record.

post/TargetList

Headers

X-Skip-Duplicate-Check'true' | 'false'

Skip duplicate check.

X-Duplicate-Source-Idstring

A record ID of the entity that is being duplicated.

Request body

idstring

An ID.

namestring

A one-line string.

categoryIdstring nullable

An ID of the record of the TargetListCategory type.

categoryNamestring nullable

A foreign record name.

entryCountinteger nullable
optedOutCountinteger nullable
descriptionstring nullable

A multi-line text.

sourceCampaignIdstring nullable
sourceCampaignNamestring nullable

A foreign record name.

createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

targetStatus'Listed' | 'Opted Out'
isOptedOutboolean

Example request

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56"
}

Response

Success.

idstring

An ID.

namestring

A one-line string.

categoryIdstring nullable

An ID of the record of the TargetListCategory type.

categoryNamestring nullable

A foreign record name.

entryCountinteger nullable
optedOutCountinteger nullable
descriptionstring nullable

A multi-line text.

sourceCampaignIdstring nullable
sourceCampaignNamestring nullable

A foreign record name.

createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

targetStatus'Listed' | 'Opted Out'
isOptedOutboolean

Example response

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56"
}