Create P and Ls API

This API is used to create a P and L.

📘

Know your endpoint

Based on the domain you use to log in to Webex Campaign, the endpoint domain for your API varies. For more information, refer to the Know Your API Endpoints section.

Headers

The following table describes the request headers:

Request HeaderDescription
content-typeapplication/json
authorizationAccess token or API Secret Key in Bearer format

Example: Bearer $(key)

Request Parameters

ParameterTypeMandatory
nameStringYesSpecifies a name for the P and L.
descriptionStringNoSpecifies the description for the P and L

Request Example


    {
        "name": "Marketing",
        "description": "Marketing P and L"
        
    }

Response Parameters

This API will return the following response parameters:

ParameterDescription
nameReturns the name of the P and L.
idReturns the id of the P and L.
messageReturns the confirmation message.

Response Example

{
    "id": "588",
    "name": "Marketing",
    "message": "P&L created successfully"
}

Failure Response Codes

The API will return code within the response as per the following table in case of failure scenarios.

HTTP Status CodeCode within API ResponseDescription
400400I/O error on post request. Cannot retry due to server authentication, in streaming mode.
400400P & L name is required
401430Authorization failed. This resource is not allowed to access using this TOKEN or KEY
401498Invalid token or Access token expired
404404Not found
405405Method not supported
409409P&L Name already exists.
500500Internal server error
5001001Invalid input JSON
Language