Campaign Partner
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:
Description:
Retrieves the sharing identity and status of a partner campaign sharing from both downstream (sharedWithMe) and upstream (sharedByMe) perspective.
Request example
curl --location --request GET 'https://api.txt.ws/v3/partnerCampaign_sharing_get/{campaignId}' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {api_key:secret_key}'
| Parameter | Type | Description |
| campaignId | Required string | campaignId |
API endpoint:
Description:
This method let you share a partner campaign with an upstream connectivity partner. The upstream connectivity partner, identified as 'upstreamCnpId' will be given role-based readonly view of campaign properties to facilitate MNO onboarding. The upstream connectivity partner (if a CSP) will be obliged to share the campaign with their connectivity partner until the campaign reaches a DCA.
Request example
curl --location --request POST 'https://api.txt.ws/v3/partnerCampaign_sharing_put/{campaignId}/{upstream_cnp}' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {api_key:secret_key}'
| Parameter | Type | Description |
| campaignId | Required string | campaignId |
| upstream_cnp | Required string | upstream_cnp |
API endpoint:
Description:
Search partner shared campaigns filtered by upstream connectivity partner This query search for campaigns shared by downstream CNP, optionally filter by upstream CNP. Example: CNP1 --> ME --> CNP2. This query lets me query for campaigns I shared filter by CNP2.
Request example
curl --location --request GET 'https://api.txt.ws/v3/partnerCampaign_sharedByMe?page=1&recordsPerPage=10' \
--header 'accept: application/json'
--header 'Authorization: Basic {api_key:secret_key}'
| Parameter | Type | Description |
| upstreamCnpId | Optional string | Alphanumeric identifier of your upstream connectivity partner. |
| brandId | Optional string | Alphanumeric identifier of the Brand tied to the campaign. |
| sharingStatus | Optional string | Filter by sharing status |
| startDate | Optional string | Shared date in yyyy-MM-dd format |
| endDate | Optional string | Shared date in yyyy-MM-dd format |
| page | Optional integer | Default value : 1 |
| recordsPerPage | Optional integer | Number of records per page. Max size is 500,Default value : 10 |
API endpoint:
Description:
This method let you decline a shared campaign request from a downstream partner. This API call is not idempotent. Once you decline a partner campaign sharing request it longer exist.
Request example
curl --location --request DELETE 'https://api.txt.ws/v3/partnerCampaign_sharing_decline/{campaignId}' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {api_key:secret_key}'
| Parameter | Type | Description |
| campaignId | Required string | Campaign alphanumeric identifier (prefixed with letter 'C') |
| explanation | Optional string | Explanation for declining campaign. Maximum length 2000 chars. |
