Manage brands

For authentication,The Username and Password should be sent as a Basic Auth tokens in the Authorization header of the request. Create account.

API endpoint:

get
https://api.txt.ws/v3/brand_get/{brandId}

Description:

Retrieve the brand record from TCR by the unique identifier assigned to the brand.

Request example

curl --location --request GET 'https://api.txt.ws/v3/brand_get/{brandId}' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {api_key:secret_key}'
Parameter Type Description
brandId Required string Brand alphanumeric identifier (prefixed with letter 'B')

API endpoint:

post
https://api.txt.ws/v3/brand_nonBlocking

Description:

This is the non-blocking version of the brand registration API call. Compared to the blocking version, this API call returns much faster because it does not wait for the initial brand scoring task, which can take more than 10 seconds to complete. The non-blocking version is suitable for an off-line process to register brands in bulk. Since the CSP cannot proceed to register a campaign for an 'unscored' brand, the CSP must wait for the BRAND_SCORE_UPDATE webhook notification event.

Request example

curl --location --request POST 'https://api.txt.ws/v3/brand_nonBlocking' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {api_key:secret_key}' \
--data-raw '{
"brand_type": "10DLC",
"entityType": "PRIVATE_PROFIT",
"firstName": "John",
"lastName": "Doe",
"displayName": "ABC Mobile",
"companyName": "ABC Inc.",
"ein": "111111111",
"einIssuingCountry": "US",
"phone": "12024567890",
"street": "123 6th Ave",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"email": "[email protected]",
"stockSymbol": "ABC",
"stockExchange": "NASDAQ",
"ipAddress": "string",
"website": "http://www.abcmobile.com",
"brandRelationship": "BASIC_ACCOUNT",
"vertical": "RETAIL",
"altBusinessId": "string",
"altBusinessIdType": "NONE",
"referenceId": "string",
"mock": false,
"tag": "List []"
}'
Parameter Type Description
entityType Required string entityType
brand_type Optional string brand_type
firstName Optional string firstName
lastName Optional string lastName
displayName Required string displayName
companyName Optional string companyName
ein Optional string ein
einIssuingCountry Optional string einIssuingCountry
phone Optional string phone
street Optional string street
city Optional string city
state Optional string state
postalCode Optional string postalCode
country Required string country
email Required string email
stockSymbol Optional string stockSymbol
stockExchange Optional string stockExchange
ipAddress Optional string ipAddress
website Optional string website
brandRelationship Required string brandRelationship
vertical Required string vertical
altBusinessId Optional string altBusinessId
altBusinessIdType Optional string altBusinessIdType
referenceId Optional string referenceId
mock Required boolean mock
tag Optional string tag

API endpoint:

get
https://api.txt.ws/v3/brand_update/{brandId}

Description:

This operation enables the CSP to keep brand details updated in the registry. The following table describes the update policy for each brand property. The re-scoring can be triggered via revet(/brand/{brandId}/revet) API

Request example

curl --location --request POST 'https://api.txt.ws/v3/brand_update/{brandId}' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {api_key:secret_key}' \
--data-raw '{
"entityType": "PRIVATE_PROFIT",
"firstName": "John",
"lastName": "Doe",
"displayName": "ABC Mobile",
"companyName": "ABC Inc.",
"ein": "111111111",
"einIssuingCountry": "US",
"phone": "12024567890",
"street": "123 6th Ave",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"email": "[email protected]",
"stockSymbol": "ABC",
"stockExchange": "NASDAQ",
"ipAddress": "string",
"website": "http://www.abcmobile.com",
"brandRelationship": "BASIC_ACCOUNT",
"vertical": "RETAIL",
"altBusinessId": "string",
"altBusinessIdType": "NONE",
}'
Parameter Type Description
brandId Required string Brand alphanumeric identifier (prefixed with letter 'B')
entityType Required string entityType
firstName Optional string firstName
lastName Optional string lastName
displayName Required string displayName
companyName Optional string companyName
ein Optional string ein
einIssuingCountry Optional string einIssuingCountry
phone Optional string phone
street Optional string street
city Optional string city
state Optional string state
postalCode Optional string postalCode
country Required string country
email Required string email
stockSymbol Optional string stockSymbol
stockExchange Optional string stockExchange
ipAddress Optional string ipAddress
website Optional string website
brandRelationship Required string brandRelationship
vertical Required string vertical
altBusinessId Optional string altBusinessId
altBusinessIdType Optional string altBusinessIdType

API endpoint:

delete
https://api.txt.ws/v3/brand_delete/{brandId}

Description:

This operation deletes a brand. A brand can be deleted if it does not have active campaigns. Once a brand is deleted the brand is in a DELETED state, and the brand cannot be restored to an ACTIVE state. Deleted brands will remain in the system for a period of TBD time and it can be searched using the GET /brand endpoint with query filter 'status' = ACTIVE. While deleted brands are searchable, all other API endpoints involving a deleted brand will result in a '502' - "Brand not found" error.

Request example

curl --location --request DELETE 'https://api.txt.ws/v3/brand_delete/{brandId}' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {api_key:secret_key}'
Parameter Type Description
brandId Required string Brand alphanumeric identifier (prefixed with letter 'B')

API endpoint:

get
https://api.txt.ws/v3/brand_externalVetting_get/{brandId}

Description:

Get list of external vetting record for a given brand.

Request example

curl --location --request GET 'https://api.txt.ws/v3/brand_externalVetting_get/{brandId}' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {api_key:secret_key}'
Parameter Type Description
brandId Required string Brand alphanumeric identifier (prefixed with letter 'B')
evpId Optional string Vetting provider ID
vettingClass Optional string Vetting class
vettingStatus Required string Available values : PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED

API endpoint:

post
https://api.txt.ws/v3/brand_externalVetting_insert/{brandId}

Description:

Order new external vetting for a brand

Request example

curl --location --request POST 'https://api.txt.ws/v3/brand_externalVetting_insert/{brandId}' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {api_key:secret_key}'

Parameter Type Description
brandId Required string Brand alphanumeric identifier (prefixed with letter 'B')
evpId Optional string Vetting provider ID
vettingClass Optional string Vetting class
additionalRequestPayload Optional string Additional brand information in json format. Required for POLITICAL type vets.example: {

API endpoint:

get
https://api.txt.ws/v3/brand_externalVetting_update/{brandId}

Description:

This operation can be used to import external vetting record from a TCR approved vetting provider. If vetting provider confirms validity of the vetting record, the vetting record will be saved with the brand in the TCR and the vetting record will be considered for future campaign qualification. The JSON request body must contain valid 'evpId', the identity of the vetting provider and the 'vettingId', the unique ID of the vetting transaction. The 'vettingToken' field is required by some vetting provider.

Request example

curl --location --request POST 'https://api.txt.ws/v3/brand_externalVetting_update/{brandId}' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {api_key:secret_key}'
Parameter Type Description
brandId Required string Brand alphanumeric identifier (prefixed with letter 'B')
evpId Required string External vetting provider ID for the brand.
vettingId Required string Unique ID that identifies a vetting transaction performed by a vetting provider. This ID is provided by the vetting provider at time of vetting.
vettingToken Required string Required by some providers for vetting record confirmation.

Join the movement
to grow your brand with
TXT Inc everyday

START
YOUR CAMPAIGN
-->