Skip to main content

Create An Ad Account

  • Updated

Use this endpoint to create an ad account under an organization. 

Request

End Point https://business.newsbreak.com/business-api/v1/ad-account/create

Method POST

Header

Field Required Data Type Description
Access-Token Y string Authorized access token. 

Request Parameters

Field Required Data Type Description
adAccountName  Y string Descriptive name of the ad account. 1–256 characters
companyName Y string Company name associated with the ad account. 1–1024 characters
industry Y string Industry classification in the form <category>//<subcategory> (e.g. "Ad Safety Risk//Other"). Must match a value from the industry list.
orgId Y string ID of the organization the ad account belongs to.

Example

curl --location --request POST 'https://business.newsbreak.com/business-api/v1/ad-account/create' \
  -H 'Content-Type: application/json' \
  -H 'Access-Token:{{Access-Token}}' \
  -d '{
      "adAccountName": "my ad account example",
      "companyName": "my company example",
      "industry": "Vehicles//Vehicle Type",
      "orgId": "123456789"
    }'
 

Response

Response Parameters

Field Data Type Description
code int Status code, see Return Codes.
errMsg string Error message when code!=0.
data object Response object.
└── id string Ad account ID.
└── orgId string Organization ID.
└── name string Ad account name.
└── orgName string Organization name.
└── companyName string Company name associated with the ad account.
└── industry string Industry classification (<category>//<subcategory>).
└── paymentType string Payment type of the ad account. Available values: PRE_PAID, POST_PAID.
└── billingThreshold Int Billing threshold in cents.
└── status string Ad account status.
└── ownerId string User ID of the ad account owner.
└── createTime string Create time of the ad account.
└── updateTime string Update time of the ad account.

Example

{
    "code": 0,
    "data": {
        "id": "987654321",
        "orgId": "1234566789",
        "name": "my ad account example",
        "orgName": "my org example",
        "companyName": "my company example",
        "industry": "Vehicles//Vehicle Type",
        "paymentType": "PRE_PAID",
        "billingThreshold": 1000,
        "status": "ACTIVE",
        "ownerId": "1234566789",
        "createTime": "1778115076",
        "updateTime": "1778115076"
    }
}

 

Related articles