{"openapi":"3.0.1","info":{"title":"Pulsepoint API Documentation","description":"Pulsepoint API Documentation","version":"2.0.0"},"servers":[{"url":"https://lifeapi.pulsepoint.com/RestApi"}],"security":[{"OAuth2_Password":["read","write"]}],"tags":[{"name":"NPI List Management","description":"PulsePoint's clients use NPI lists for campaign targeting. These lists can change often and are customizable by each client. Clients now have direct access and complete control of their standard NPI lists and NPI lists with attributes via the NPI List API.\n\nThis document describes the functionality supported by the NPI List API. PulsePoint provides a REST API to access and manage the following actions for two different types of NPI lists:"},{"name":"Authentication","description":"OAuth2 authentication and token management endpoints"},{"name":"Campaign Import","description":"APIs for Campaign Import Service"},{"name":"Targeting Metadata","description":"APIs for retrieving targeting metadata"},{"name":"Campaign Management","description":"APIs for Campaign Service"},{"name":"Targeting Metadata","description":"APIs for retrieving health taxonomy targeting metadata"}],"paths":{"/oauth/token":{"post":{"tags":["Authentication"],"summary":"Get Bearer Token","description":"OAuth2 Token endpoint supporting multiple grant types:\n\n**Password Grant Flow:**\n- Set `grant_type=password`\n- Provide `username` and `password`\n- Requires Basic Auth with client_id and client_secret\n\n**Refresh Token Flow:**\n- Set `grant_type=refresh_token`\n- Provide `refresh_token`\n- Requires Basic Auth with client_id and client_secret\n\n","operationId":"OAuth2_Token","requestBody":{"description":"Form data for OAuth2 token request","content":{"application/x-www-form-urlencoded":{"schema":{"required":["grant_type"],"type":"object","properties":{"grant_type":{"type":"string","description":"Grant type: 'password' for user credentials, 'refresh_token' for token refresh","example":"password","enum":["password","refresh_token"]},"username":{"type":"string","description":"User's login username (required for password grant)","example":"user123"},"password":{"type":"string","description":"User's login password (required for password grant)","example":"password123"},"refresh_token":{"type":"string","description":"Refresh token (required for refresh_token grant)","example":"diz8j9B3D..."}},"description":"OAuth2 Token Request - supports both password and refresh_token grant types"}}}},"responses":{"200":{"description":"Successful token response","content":{"application/json":{"schema":{"type":"object","properties":{"access_token":{"type":"string","description":"Access token","example":"XA99bm0HW5pO..."},"token_type":{"type":"string","description":"Token type","example":"bearer"},"refresh_token":{"type":"string","description":"Refresh token","example":"hTl4s_x2lG0hl..."},"expires_in":{"type":"integer","description":"Token expiration time in seconds","example":6000},"scope":{"type":"string","description":"Token scope","example":"read write"}}}}}},"400":{"description":"Bad Request - Missing or invalid parameters (OAuth2 error format)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"OAuth2 error code","example":"invalid_request"},"error_description":{"type":"string","description":"Error description","example":"refresh_token parameter not provided"}}}}}},"401":{"description":"Unauthorized - Invalid credentials or tokens","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp","example":"2025-09-17T14:41:37.253+00:00"},"status":{"type":"integer","description":"HTTP status code","example":401},"error":{"type":"string","description":"Error type","example":"Unauthorized"},"message":{"type":"string","description":"Error message","example":""},"path":{"type":"string","description":"Request path","example":"/RestApi/oauth/token"}}}}}}},"security":[{"BasicAuth":[]}]}},"/v2/npi/npi-list/{npiListId}":{"get":{"tags":["NPI List Management"],"summary":"Get NPI List","description":"This endpoint returns the details of an NPI List with NPI numbers of a given NPI List Id","operationId":"npi_get_by_id","parameters":[{"name":"npiListId","in":"path","description":"NPI List Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NPIGroupWithRefsResponse"}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-31T16:25:36.416974","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"npiListId","message":"You do not have permission to access this NPI List.","value":42067}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T16:24:11.342602","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"NPI_LIST_NOT_FOUND","message":"NPI List not found for the given id.","field":"npiListId","value":4206756345}]}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}},"put":{"tags":["NPI List Management"],"summary":"Replace NPIs in a list","description":"This endpoint replaces the entire NPI List with the given set of NPI numbers","operationId":"npi_replace","parameters":[{"name":"npiListId","in":"path","description":"NPI List Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceNPIsInNPIListRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceNPIListResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-31T17:52:16.766143","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_VALUE","field":"npis","message":"At least one npi is required"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-31T16:25:36.416974","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"npiListId","message":"You do not have permission to access this NPI List.","value":42067}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T16:24:11.342602","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"NPI_LIST_NOT_FOUND","message":"NPI List not found for the given id.","field":"npiListId","value":4206756345}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"NPI Limit exceeded":{"description":"NPI Limit exceeded","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:11:50.336414","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"LIMIT_EXCEEDED","message":"Maximum NPI supported limit is exceeded.","field":"npis","value":{"npiCount":2300000,"maxNPISupportLimit":1000000}}]}}},"NPI list is archived":{"description":"NPI list is archived","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:55:10.955953","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_OPERATION","message":"List is archived and needs to be un-archived in order to be updated.","field":"npiListId","value":42505}]}}},"Smart list cannot be updated":{"description":"Smart list cannot be updated","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:58:36.017761","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_OPERATION","message":"Smart lists cannot be updated or deleted using the NPI List API.","field":"npiListId","value":42505}]}}},"Pulsepoint list cannot be updated":{"description":"Pulsepoint list cannot be updated","value":{"success":false,"status":422,"timestamp":"2025-10-31T18:01:01.149057","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_OPERATION","message":"PulsePoint provided lists cannot be updated or deleted using the NPI List API.","field":"npiListId","value":42505}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}},"patch":{"tags":["NPI List Management"],"summary":"Add or Remove NPIs","description":"This endpoint adds or removes NPI numbers from an existing NPI List.","operationId":"npi_update","parameters":[{"name":"npiListId","in":"path","description":"NPI List Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOrRemoveNPIsRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNPIListResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-31T18:13:42.254478","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_ENUM","field":"operation","message":"Operation must be one of the values: add, remove"},{"code":"VALIDATION_ERROR","field":"npis","message":"NPI numbers are required to be 10 digits"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-31T16:25:36.416974","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"npiListId","message":"You do not have permission to access this NPI List.","value":42067}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T16:24:11.342602","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"NPI_LIST_NOT_FOUND","message":"NPI List not found for the given id.","field":"npiListId","value":4206756345}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"NPI Limit exceeded":{"description":"NPI Limit exceeded","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:11:50.336414","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"LIMIT_EXCEEDED","message":"Maximum NPI supported limit is exceeded.","field":"npis","value":{"npiCount":2300000,"maxNPISupportLimit":1000000}}]}}},"NPI List is archived":{"description":"NPI List is archived","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:55:10.955953","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_OPERATION","message":"List is archived and needs to be un-archived in order to be updated.","field":"npiListId","value":42505}]}}},"Smart list cannot be updated":{"description":"Smart list cannot be updated","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:58:36.017761","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_OPERATION","message":"Smart lists cannot be updated or deleted using the NPI List API.","field":"npiListId","value":42505}]}}},"Pulsepoint list cannot be updated":{"description":"Pulsepoint list cannot be updated","value":{"success":false,"status":422,"timestamp":"2025-10-31T18:01:01.149057","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_OPERATION","message":"PulsePoint provided lists cannot be updated or deleted using the NPI List API.","field":"npiListId","value":42505}]}}},"Cannot remove all NPIs":{"description":"Cannot remove all NPIs","value":"{\n    \"success\": false,\n    \"status\": 422,\n    \"timestamp\": \"2025-10-31T18:19:34.899802\",\n    \"path\": \"/RestApi/v2/{resource}\",\n    \"operation\": \"{HTTP_METHOD}\",\n    \"error\": {\n        \"code\": \"BUSINESS_RULE_VIOLATION\",\n        \"message\": \"Operation violates business rules.\",\n        \"details\": [\n            {\n                \"code\": \"INVALID_OPERATION\",\n                \"message\": \"Cannot remove all NPIs from the list.\",\n                \"field\": \"npis\",\n                \"value\": {\n                    \"existingNPIs\": 4\n                    \"requestedRemovals\": 4,\n                }\n            }\n        ]\n    }\n}"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/npi/npi-list/{npiListId}/attributes":{"get":{"tags":["NPI List Management"],"summary":"Get NPI List with attributes","description":"This endpoint returns the details of an NPI List with NPI Attributes of a given NPI List Id","operationId":"npi_attributes_get_by_id","parameters":[{"name":"npiListId","in":"path","description":"NPI List Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NPIGroupAttributeResponse"}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-31T16:25:36.416974","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"npiListId","message":"You do not have permission to access this NPI List.","value":42067}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T16:24:11.342602","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"NPI_LIST_NOT_FOUND","message":"NPI List not found for the given id.","field":"npiListId","value":4206756345}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"NPI List is not attribute list":{"description":"NPI List is not attribute list","value":{"success":false,"status":422,"timestamp":"2025-10-31T16:56:13.259209","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_TYPE","message":"NPI Id provided is not an NPI Attribute List.","field":"npiListId","value":42067}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}},"put":{"tags":["NPI List Management"],"summary":"Replace NPI attributes in a list","description":"This endpoint replaces the entire NPI List with the given set of NPI Attributes.","operationId":"npi_attributes_replace","parameters":[{"name":"npiListId","in":"path","description":"NPI List Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceAttributesInNPIListRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NPIGroupAttributeReplaceResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-31T17:17:53.018334","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_RANGE","field":"npiColumnIndex","message":"NPI column index must be greater than or equal to 0"},{"code":"INVALID_VALUE","field":"attributes","message":"At least one attribute is required"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-31T16:25:36.416974","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"npiListId","message":"You do not have permission to access this NPI List.","value":42067}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T16:24:11.342602","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"NPI_LIST_NOT_FOUND","message":"NPI List not found for the given id.","field":"npiListId","value":4206756345}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"NPI Attribute Limit exceeded":{"description":"NPI Attribute Limit exceeded","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:34:46.547057","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"LIMIT_EXCEEDED","message":"Maximum NPI attributes columns limit is exceeded.","field":"attributes","value":{"maximumAttributeColumnLimit":35}}]}}},"Duplicate Attribute found":{"description":"Duplicate Attribute found","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:38:33.275416","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"DUPLICATE_FOUND","message":"Attribute Compass_ID is found more than once.","field":"attributes"}]}}},"NPI list is archived":{"description":"NPI list is archived","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:55:10.955953","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_OPERATION","message":"List is archived and needs to be un-archived in order to be updated.","field":"npiListId","value":42505}]}}},"Smart list cannot be updated":{"description":"Smart list cannot be updated","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:58:36.017761","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_OPERATION","message":"Smart lists cannot be updated or deleted using the NPI List API.","field":"npiListId","value":42505}]}}},"Pulsepoint list cannot be updated":{"description":"Pulsepoint list cannot be updated","value":{"success":false,"status":422,"timestamp":"2025-10-31T18:01:01.149057","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_OPERATION","message":"PulsePoint provided lists cannot be updated or deleted using the NPI List API.","field":"npiListId","value":42505}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}},"patch":{"tags":["NPI List Management"],"summary":"Update NPI List With Attributes","description":"Use this endpoint to add or remove NPI with attribute records on a given NPI List. Certain fields are required to add records and other fields are required for removing records.","operationId":"npi_attributes_update","parameters":[{"name":"npiListId","in":"path","description":"NPI List Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOrRemoveNPIAttrsRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NPIGroupAttributeUpdateResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-31T18:13:42.254478","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_ENUM","field":"operation","message":"Operation must be one of the values: add, remove"},{"code":"VALIDATION_ERROR","field":"npiColumnIndex","message":"NPI column index is required for add operation"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-31T16:25:36.416974","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"npiListId","message":"You do not have permission to access this NPI List.","value":42067}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T16:24:11.342602","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"NPI_LIST_NOT_FOUND","message":"NPI List not found for the given id.","field":"npiListId","value":4206756345}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"NPI Attributes Limit exceeded":{"description":"NPI Attributes Limit exceeded","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:11:50.336414","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"LIMIT_EXCEEDED","message":"Maximum NPI attributes rows limit is exceeded.","field":"attributeValues","value":{"maximumAttributeRowsLimit":230000,"providedAttributeValuesCount":100000}}]}}},"NPI List is archived":{"description":"NPI List is archived","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:55:10.955953","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_OPERATION","message":"List is archived and needs to be un-archived in order to be updated.","field":"npiListId","value":42505}]}}},"Smart list cannot be updated":{"description":"Smart list cannot be updated","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:58:36.017761","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_OPERATION","message":"Smart lists cannot be updated or deleted using the NPI List API.","field":"npiListId","value":42505}]}}},"Cannot remove all NPIs":{"description":"Cannot remove all NPIs","value":"{\n    \"success\": false,\n    \"status\": 422,\n    \"timestamp\": \"2025-10-31T18:19:34.899802\",\n    \"path\": \"/RestApi/v2/{resource}\",\n    \"operation\": \"{HTTP_METHOD}\",\n    \"error\": {\n        \"code\": \"BUSINESS_RULE_VIOLATION\",\n        \"message\": \"Operation violates business rules.\",\n        \"details\": [\n            {\n                \"code\": \"INVALID_OPERATION\",\n                \"message\": \"Cannot remove all NPIs from the list.\",\n                \"field\": \"npis\",\n                \"value\": {\n                    \"existingNPIs\": 4\n                    \"requestedRemovals\": 4,\n                }\n            }\n        ]\n    }\n}"},"Attributes doesn't match":{"description":"Attributes doesn't match","value":"{\n    \"success\": false,\n    \"status\": 422,\n    \"timestamp\": \"2025-10-31T18:19:34.899802\",\n    \"path\": \"/RestApi/v2/{resource}\",\n    \"operation\": \"{HTTP_METHOD}\",\n    \"error\": {\n        \"code\": \"BUSINESS_RULE_VIOLATION\",\n        \"message\": \"Operation violates business rules.\",\n        \"details\": [\n            {\n                \"code\": \"INVALID_DATA\",\n                \"message\": \"Attribute names or order do not match existing attributes in the NPI list..\",\n                \"field\": \"attributes\",\n                \"value\": {\n                    \"index\": 4,\n                    \"expectedAttribute\": campaign_name,\n                    \"providedAttribute\": campaign\n                }\n            }\n        ]\n    }\n}"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/lifecreative/{creativeId}":{"get":{"tags":["Account Assets"],"summary":"Get Creative","description":"This endpoint returns the Creative details for a given Creative Id","operationId":"creative_get_by_id","parameters":[{"name":"creativeId","in":"path","description":"Creative Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/HtmlCreativeResponse"},{"$ref":"#/components/schemas/ExpandableHtmlCreativeResponse"},{"$ref":"#/components/schemas/VideoCreativeResponse"}]}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:56:31.960991","path":"/RestApi/v2/lifecreative/{creativeId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"creativeId","message":"You do not have permission to access this Creative.","value":321071}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-30T22:55:37.800868","path":"/RestApi/v2/lifecreative/{creativeId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"CREATIVE_NOT_FOUND","message":"Creative not found for the given id.","field":"creativeId","value":3210715555}]}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}},"put":{"tags":["Account Assets"],"summary":"Update Creative","description":"This endpoint updates an existing Creative.","operationId":"creative_replace","parameters":[{"name":"creativeId","in":"path","description":"Creative Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Creative data to update","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/HtmlCreativeRequest"},{"$ref":"#/components/schemas/ExpandableHtmlCreativeRequest"},{"$ref":"#/components/schemas/VideoCreativeRequest"}]}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/HtmlCreativeResponse"},{"$ref":"#/components/schemas/ExpandableHtmlCreativeResponse"},{"$ref":"#/components/schemas/VideoCreativeResponse"}]}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-30T22:57:54.246591","path":"/RestApi/v2/lifecreative/account/{accountId}","operation":"POST","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"REQUIRED_FIELD","field":"advertiserName","message":"Advertiser name is required."},{"code":"INVALID_VALUE","field":"domainLandingPage","message":"Domain landing page must be a valid URL."},{"code":"INVALID_VALUE","field":"name","message":"Creative name must be between 1 and 80 characters."},{"code":"INVALID_ENUM","field":"adChoicesIcon","message":"Ad choices icon must be one of the following values: TopRight, TopLeft, BottomRight, BottomLeft, None."}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:56:31.960991","path":"/RestApi/v2/lifecreative/{creativeId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"creativeId","message":"You do not have permission to access this Creative.","value":321071}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"Advertiser not found":{"description":"Advertiser not found","value":{"success":false,"status":404,"timestamp":"2025-10-30T22:59:34.707588","path":"/RestApi/v2/lifecreative/account/{accountId}","operation":"POST","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"ADVERTISER_NOT_FOUND","message":"No Advertiser found for the given name","field":"advertiserName","value":"abcde"}]}}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"Name not unique":{"description":"Name not unique","value":{"success":false,"status":422,"timestamp":"2025-10-30T23:02:25.06716","path":"/RestApi/v2/lifecreative/account/{accountId}","operation":"POST","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"DUPLICATE_NAME","message":"Creative name must be unique","field":"name","value":"creative_abc"}]}}},"Invalid category names":{"description":"Invalid category names","value":{"success":false,"status":422,"timestamp":"2025-10-30T23:03:52.003573","path":"/RestApi/v2/lifecreative/account/{accountId}","operation":"POST","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_VALUE","message":"Invalid IAB Category Names provided","field":"categoryNames","value":{"categoryNames":["Family & Parenting","random category"]}}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/lifecreative/account/{accountId}/creativeassociation":{"put":{"tags":["Campaign Management"],"summary":"Assign Creatives to Tactic","description":"This endpoint assigns Creatives to a Tactic.","operationId":"creative_association","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssignCreativeRequest"}}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-30T23:21:18.778472","path":"/RestApi/v2/lifecreative/account/{accountId}/creativeassociation","operation":"PUT","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"Tactic_NOT_FOUND","message":"No adGroup found with the given tactic id","field":"tacticId","value":"2045064342"}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"Limit exceeded":{"description":"Limit exceeded","value":{"success":false,"status":422,"timestamp":"2025-10-30T23:16:44.668443","path":"/RestApi/v2/lifecreative/account/{accountId}/creativeassociation","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"LIMIT_EXCEEDED","message":"Maximum Creative supported limit of - 2 is exceeded.","field":"payload","value":"2"}]}}},"Invalid advertiser mapping":{"description":"Invalid advertiser mapping","value":{"success":false,"status":422,"timestamp":"2025-10-30T23:19:18.322696","path":"/RestApi/v2/lifecreative/account/{accountId}/creativeassociation","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_VALUE","message":"Creative IDs not mapped to same Advertiser for Tactic 204506","field":"creativesToAssign or creativesToUnAssign"}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/account/{accountId}/lineitems/{lineItemId}":{"get":{"tags":["Campaign Management"],"summary":"Get Line Item","description":"This endpoint returns the Line Item details of a given LineItem Id","operationId":"lineitem_get_by_id","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineItemId","in":"path","description":"LineItem Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemResponse"}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:47:20.306667","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"lineItemId","message":"You do not have permission to access this LineItem.","value":119593}]}}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"success":false,"status":404,"timestamp":"2025-10-30T19:44:57.478786","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"LINEITEM_NOT_FOUND","message":"LineItem not found for the given id.","field":"lineItemId","value":1058365455}]}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}},"put":{"tags":["Campaign Management"],"summary":"Replace Line Item","description":"This endpoint replaces the entire Line Item with the provided data","operationId":"lineitem_replace","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineItemId","in":"path","description":"LineItem Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceLineItemResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-30T20:03:37.901516","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"PUT","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"REQUIRED_FIELD","field":"flights[0].endDate","message":"End date is required"},{"code":"VALIDATION_ERROR","field":"flights[0].startDate","message":"Start date must be in the format MM-dd-yyyy HH:mm:ss"},{"code":"VALIDATION_ERROR","field":"flights[0].paceAheadPercent","message":"Pace Ahead percent is required when pacingMode is 'AHEAD'"},{"code":"INVALID_ENUM","field":"budgetDistribution","message":"Budget distribution must be one of the following values: Priority, Dollars, Percent"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:47:20.306667","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"lineItemId","message":"You do not have permission to access this LineItem.","value":119593}]}}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"success":false,"status":404,"timestamp":"2025-10-30T19:44:57.478786","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"LINEITEM_NOT_FOUND","message":"LineItem not found for the given id.","field":"lineItemId","value":1058365455}]}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"Conflicting Flight dates":{"description":"Conflicting Flight dates","value":{"success":false,"status":422,"timestamp":"2025-10-30T20:28:13.286328","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"CONFLICTING_DATES","message":"Flight dates overlap with other flights.","field":"flights","value":{"flightIndex":2,"flightStartDate":"11-08-2025 00:00:00","flightEndDate":"11-12-2025 23:59:59","conflictingFlightIndex":4,"conflictingFlightStartDate":"11-01-2025 00:00:00","conflictingFlightEndDate":"11-30-2025 22:59:59"}}]}}},"LineItem budget exceeded":{"description":"LineItem budget exceeded","value":{"success":false,"status":422,"timestamp":"2025-10-30T20:34:33.36916","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"BUDGET_EXCEEDED","message":"Total flight budget must not exceed Campaign Budget.","field":"flights","value":{"totalFlightBudget":150000.1,"unaccountedCampaignBudget":49}}]}}},"Invalid flight end date":{"description":"Invalid flight end date","value":{"success":false,"status":422,"timestamp":"2025-10-30T20:36:56.314879","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_VALUE","message":"Flight end date cannot be earlier than start date.","field":"flights","value":{"flightIndex":3,"flightEndDate":"10-30-2025 22:59:59","flightStartDate":"11-01-2025 00:00:00"}}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}},"delete":{"tags":["Campaign Management"],"summary":"Delete Line Item","description":"This endpoint deletes a Line Item by its ID","operationId":"lineitem_delete","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineItemId","in":"path","description":"LineItem Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLineItemRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLineItemResponse"}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:47:20.306667","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"lineItemId","message":"You do not have permission to access this LineItem.","value":119593}]}}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"success":false,"status":404,"timestamp":"2025-10-30T19:44:57.478786","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"LINEITEM_NOT_FOUND","message":"LineItem not found for the given id.","field":"lineItemId","value":1058365455}]}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}},"patch":{"tags":["Campaign Management"],"summary":"Update Line Item","description":"This endpoint updates the details of a Line Item","operationId":"lineitem_update","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineItemId","in":"path","description":"LineItem Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLineItemRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-30T20:03:37.901516","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"PUT","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"REQUIRED_FIELD","field":"flights[0].endDate","message":"End date is required"},{"code":"VALIDATION_ERROR","field":"flights[0].startDate","message":"Start date must be in the format MM-dd-yyyy HH:mm:ss"},{"code":"VALIDATION_ERROR","field":"flights[0].paceAheadPercent","message":"Pace Ahead percent is required when pacingMode is 'AHEAD'"},{"code":"INVALID_ENUM","field":"budgetDistribution","message":"Budget distribution must be one of the following values: Priority, Dollars, Percent"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:47:20.306667","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"lineItemId","message":"You do not have permission to access this LineItem.","value":119593}]}}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"success":false,"status":404,"timestamp":"2025-10-30T19:44:57.478786","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"LINEITEM_NOT_FOUND","message":"LineItem not found for the given id.","field":"lineItemId","value":1058365455}]}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"Conflicting Flight dates":{"description":"Conflicting Flight dates","value":{"success":false,"status":422,"timestamp":"2025-10-30T20:28:13.286328","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"CONFLICTING_DATES","message":"Flight dates overlap with other flights.","field":"flights","value":{"flightId":128971,"flightStartDate":"11-08-2025 00:00:00","flightEndDate":"11-12-2025 23:59:59","conflictingFlightId":129009,"conflictingFlightStartDate":"11-01-2025 00:00:00","conflictingFlightEndDate":"11-30-2025 22:59:59"}}]}}},"LineItem budget exceeded":{"description":"LineItem budget exceeded","value":{"success":false,"status":422,"timestamp":"2025-10-30T20:34:33.36916","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"BUDGET_EXCEEDED","message":"Total flight budget must not exceed Campaign Budget.","field":"flights","value":{"totalFlightBudget":150000.1,"unaccountedCampaignBudget":49}}]}}},"Invalid flight end date":{"description":"Invalid flight end date","value":{"success":false,"status":422,"timestamp":"2025-10-30T20:36:56.314879","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_VALUE","message":"Flight end date cannot be earlier than start date.","field":"flights","value":{"flightId":129009,"flightEndDate":"10-30-2025 22:59:59","flightStartDate":"11-01-2025 00:00:00"}}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/npi/npi-list/account/{accountId}":{"get":{"tags":["NPI List Management"],"summary":"Get NPI Lists by Account","description":"This endpoint returns a list of all NPI Lists associated with an Account Id.","operationId":"npis_get_by_account_id","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NPIGroupsByAccountIdResponse"}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-31T16:46:58.541646","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"accountId","message":"You do not have permission to access this Account.","value":559145}]}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}},"post":{"tags":["NPI List Management"],"summary":"Create NPI List","description":"This endpoint creates an NPI List with given NPI numbers","operationId":"npi_create","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NPIGroupRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NPIGroupWithRefsResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-31T17:07:30.186075","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_ENUM","field":"applications","message":"Application names must be one of the values: LIFE, SIGNAL, SOCIAL_INTEGRATIONS"},{"code":"VALIDATION_ERROR","field":"advertisers","message":"One or more advertiser is null or empty"},{"code":"INVALID_VALUE","field":"name","message":"NPI List name must be between 1 and 100 characters"},{"code":"VALIDATION_ERROR","field":"npis","message":"NPI numbers are required to be 10 digits"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-31T16:46:58.541646","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"accountId","message":"You do not have permission to access this Account.","value":559145}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T17:05:31.452949","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"ADVERTISERS_NOT_FOUND","message":"No valid advertisers found for the provided names.","field":"advertisers","value":"abc"}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"NPI list name is not unique":{"description":"NPI list name is not unique","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:09:31.425927","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"DUPLICATE_NAME","message":"NPI List name must be unique within the account.","field":"name","value":"npi list 123"}]}}},"NPI Limit exceeded":{"description":"NPI Limit exceeded","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:11:50.336414","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"LIMIT_EXCEEDED","message":"Maximum NPI supported limit is exceeded.","field":"npis","value":{"npiCount":2300000,"maxNPISupportLimit":1000000}}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/npi/npi-list/account/{accountId}/attributes":{"post":{"tags":["NPI List Management"],"summary":"Create NPI List with attributes","description":"This endpoint creates an NPI List with given NPI Attributes.","operationId":"npi_attributes_create","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NPIGroupAttributeRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NPIGroupAttributeResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-31T17:17:53.018334","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_RANGE","field":"npiColumnIndex","message":"NPI column index must be greater than or equal to 0"},{"code":"INVALID_ENUM","field":"applications","message":"Application names must be one of the values: LIFE, SIGNAL, SOCIAL_INTEGRATIONS"},{"code":"INVALID_VALUE","field":"attributes","message":"At least one attribute is required"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-31T16:46:58.541646","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"accountId","message":"You do not have permission to access this Account.","value":559145}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T17:05:31.452949","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"ADVERTISERS_NOT_FOUND","message":"No valid advertisers found for the provided names.","field":"advertisers","value":"abc"}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"NPI list name is not unique":{"description":"NPI list name is not unique","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:09:31.425927","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"DUPLICATE_NAME","message":"NPI List name must be unique within the account.","field":"name","value":"npi list 123"}]}}},"NPI Attribute Limit exceeded":{"description":"NPI Attribute Limit exceeded","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:34:46.547057","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"LIMIT_EXCEEDED","message":"Maximum NPI attributes columns limit is exceeded.","field":"attributes","value":{"maximumAttributeColumnLimit":35}}]}}},"Duplicate Attribute found":{"description":"Duplicate Attribute found","value":{"success":false,"status":422,"timestamp":"2025-10-31T17:38:33.275416","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"DUPLICATE_FOUND","message":"Attribute Compass_ID is found more than once.","field":"attributes"}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/lifecreative/account/{accountId}":{"post":{"tags":["Account Assets"],"summary":"Create Creative","description":"This endpoint creates a Creative.","operationId":"creative_create","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Creative data to create","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/HtmlCreativeRequest"},{"$ref":"#/components/schemas/ExpandableHtmlCreativeRequest"},{"$ref":"#/components/schemas/VideoCreativeRequest"}]}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/HtmlCreativeResponse"},{"$ref":"#/components/schemas/ExpandableHtmlCreativeResponse"},{"$ref":"#/components/schemas/VideoCreativeResponse"}]}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-30T22:57:54.246591","path":"/RestApi/v2/lifecreative/account/{accountId}","operation":"POST","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"REQUIRED_FIELD","field":"advertiserName","message":"Advertiser name is required."},{"code":"INVALID_VALUE","field":"domainLandingPage","message":"Domain landing page must be a valid URL."},{"code":"INVALID_VALUE","field":"name","message":"Creative name must be between 1 and 80 characters."},{"code":"INVALID_ENUM","field":"adChoicesIcon","message":"Ad choices icon must be one of the following values: TopRight, TopLeft, BottomRight, BottomLeft, None."}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"Advertiser not found":{"description":"Advertiser not found","value":{"success":false,"status":404,"timestamp":"2025-10-30T22:59:34.707588","path":"/RestApi/v2/lifecreative/account/{accountId}","operation":"POST","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"ADVERTISER_NOT_FOUND","message":"No Advertiser found for the given name","field":"advertiserName","value":"abcde"}]}}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"Name not unique":{"description":"Name not unique","value":{"success":false,"status":422,"timestamp":"2025-10-30T23:02:25.06716","path":"/RestApi/v2/lifecreative/account/{accountId}","operation":"POST","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"DUPLICATE_NAME","message":"Creative name must be unique","field":"name","value":"creative_abc"}]}}},"Invalid category names":{"description":"Invalid category names","value":{"success":false,"status":422,"timestamp":"2025-10-30T23:03:52.003573","path":"/RestApi/v2/lifecreative/account/{accountId}","operation":"POST","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_VALUE","message":"Invalid IAB Category Names provided","field":"categoryNames","value":{"categoryNames":["Family & Parenting","random category"]}}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/campaignImport/":{"post":{"tags":["Campaign Import"],"summary":"Create Campaign","description":"This endpoint creates a Campaign and its Line Item(s).","operationId":"campaign_import_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignImportCollectionRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"examples":{"validation errors":{"description":"validation errors","value":{"success":false,"status":400,"timestamp":"2025-10-31T21:09:43.805177","path":"/RestApi/v2/campaignImport/","operation":"POST","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_ENUM","field":"campaign.lineItems[0].costModel","message":"Cost model must be one of the following values: CPM, Fixed CPM"},{"code":"REQUIRED_FIELD","field":"campaign.lineItems[0].flights[0].startDate","message":"Start date is required"},{"code":"REQUIRED_FIELD","field":"campaign.account","message":"Account ID is required"},{"code":"INVALID_VALUE","field":"campaign.advertiser","message":"Advertiser name must not be empty"}]}}},"business validation errors":{"description":"business validation errors","value":{"success":false,"status":400,"timestamp":"2025-10-31T21:19:29.717097","path":"/RestApi/v2/campaignImport/","operation":"POST","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_VALUE","message":"Campaign  / 1/ custom field name 'Campaign_15_sep_from_api_field_name' is already exists and cannot be created as new."},{"code":"INVALID_VALUE","message":"LineItem 1/ Flight 1: Start date cannot be in the past."},{"code":"INVALID_VALUE","message":"LineItem 1/ Flight 2: Start date cannot be in the past."}]}}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"examples":{"Create campaign permission error":{"description":"Create campaign permission error","value":{"success":false,"status":403,"timestamp":"2025-10-31T21:16:45.687924","path":"/RestApi/v2/campaignImport/","operation":"POST","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","message":"User does not have create campaign permission on this account.","value":{"accountId":559145}}]}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T21:15:16.128918","path":"/RestApi/v2/campaignImport/","operation":"POST","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"ACCOUNT_NOT_FOUND","message":"Account not found for the given id.","field":"accountId","value":559145}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"Campaign name not unique":{"description":"Campaign name not unique","value":{"success":false,"status":422,"timestamp":"2025-10-31T21:24:24.913407","path":"/RestApi/v2/campaignImport/","operation":"POST","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"DUPLICATE_NAME","message":"Campaign Name is not unique","field":"name","value":"campaign 123"}]}}},"LineItem name not unique":{"description":"LineItem name not unique","value":{"success":false,"status":422,"timestamp":"2025-10-31T21:24:24.913407","path":"/RestApi/v2/campaignImport/","operation":"POST","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"DUPLICATE_NAME","message":"Line Item Name is not unique","field":"name","value":"lineitem 123"}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/account/{accountId}/tactics":{"post":{"tags":["Campaign Management"],"summary":"Create Tactic","description":"This endpoint creates a Tactic","operationId":"tactic_create","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TacticRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TacticResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-30T22:12:19.87417","path":"/RestApi/v2/tactic/{tacticId}","operation":"PUT","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_VALUE","field":"percentAllocation","message":"Percent allocation must be a valid amount with up to 3 digits and 2 decimal places"},{"code":"INVALID_RANGE","field":"maxBidPrice","message":"Max Bid Price must be less than or equal to 999999999.99"},{"code":"INVALID_VALUE","field":"dollarAllocation","message":"Dollar Allocation must be a valid amount with up to 9 digits and 2 decimal places"},{"code":"INVALID_VALUE","field":"baseBidPrice","message":"Base Bid Price must be a valid amount with up to 9 digits and 2 decimal places"},{"code":"INVALID_RANGE","field":"priority","message":"Priority must less than or equal to 999"},{"code":"INVALID_RANGE","field":"percentAllocation","message":"Percent allocation must be less than or equal to 100.00"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:42:23.24961","path":"/RestApi/v2/tactic/{tacticId}","operation":"PUT","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"tacticId","message":"You do not have permission to access this Tactic.","value":205466}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"BaseBidPrice cannot exceed MaxBidPrice":{"description":"BaseBidPrice cannot exceed MaxBidPrice","value":{"success":false,"status":422,"timestamp":"2025-10-30T22:22:53.066582","path":"/RestApi/v2/tactic/{tacticId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"BUDGET_EXCEEDED","message":"BaseBidPrice cannot exceed MaxBidPrice","field":"baseBidPrice","value":{"baseBidPrice":200,"maxBidPrice":100}}]}}},"Dollar Allocation cannot exceed LineItem Budget":{"description":"Dollar Allocation cannot exceed LineItem Budget","value":{"success":false,"status":422,"timestamp":"2025-10-30T22:29:21.419862","path":"/RestApi/v2/tactic/{tacticId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"BUDGET_EXCEEDED","message":"Dollar Allocation cannot exceed LineItem Budget","field":"dollarAllocation","value":{"lineItemBudget":50,"dollarAllocation":136}}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/account/{accountId}/lineitems":{"post":{"tags":["Campaign Management"],"summary":"Create Line Item","description":"This endpoint creates a new Line Item","operationId":"lineitem_create","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLineItemRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLineItemResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-30T20:03:37.901516","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"PUT","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"REQUIRED_FIELD","field":"flights[0].endDate","message":"End date is required"},{"code":"VALIDATION_ERROR","field":"flights[0].startDate","message":"Start date must be in the format MM-dd-yyyy HH:mm:ss"},{"code":"VALIDATION_ERROR","field":"flights[0].paceAheadPercent","message":"Pace Ahead percent is required when pacingMode is 'AHEAD'"},{"code":"INVALID_ENUM","field":"budgetDistribution","message":"Budget distribution must be one of the following values: Priority, Dollars, Percent"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:47:20.306667","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"lineItemId","message":"You do not have permission to access this LineItem.","value":119593}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"Conflicting Flight dates":{"description":"Conflicting Flight dates","value":{"success":false,"status":422,"timestamp":"2025-10-30T20:28:13.286328","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"CONFLICTING_DATES","message":"Flight dates overlap with other flights.","field":"flights","value":{"flightIndex":2,"flightStartDate":"11-08-2025 00:00:00","flightEndDate":"11-12-2025 23:59:59","conflictingFlightIndex":4,"conflictingFlightStartDate":"11-01-2025 00:00:00","conflictingFlightEndDate":"11-30-2025 22:59:59"}}]}}},"LineItem budget exceeded":{"description":"LineItem budget exceeded","value":{"success":false,"status":422,"timestamp":"2025-10-30T20:34:33.36916","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"BUDGET_EXCEEDED","message":"Total flight budget must not exceed Campaign Budget.","field":"flights","value":{"totalFlightBudget":150000.1,"unaccountedCampaignBudget":49}}]}}},"Invalid flight end date":{"description":"Invalid flight end date","value":{"success":false,"status":422,"timestamp":"2025-10-30T20:36:56.314879","path":"/RestApi/v2/lineitem/{lineItemId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_VALUE","message":"Flight end date cannot be earlier than start date.","field":"flights","value":{"flightIndex":3,"flightEndDate":"10-30-2025 22:59:59","flightStartDate":"11-01-2025 00:00:00"}}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/account/{accountId}/tactics/{tacticId}":{"get":{"tags":["Campaign Management"],"summary":"Get Tactic","description":"This endpoint returns the Tactic details of a given Tactic Id","operationId":"tactic_get_by_id","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tacticId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TacticResponse"}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:42:23.24961","path":"/RestApi/v2/tactic/{tacticId}","operation":"PUT","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"tacticId","message":"You do not have permission to access this Tactic.","value":205466}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-30T22:01:33.734282","path":"/RestApi/v2/tactic/{tacticId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"TACTIC_NOT_FOUND","message":"Tactic not found for the given id.","field":"tacticId","value":2054668}]}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}},"delete":{"tags":["Campaign Management"],"summary":"Delete Tactic","description":"This endpoint deletes a Tactic by its ID","operationId":"tactic_delete","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tacticId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTacticRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTacticResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-30T22:12:19.87417","path":"/RestApi/v2/tactic/{tacticId}","operation":"PUT","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_VALUE","field":"percentAllocation","message":"Percent allocation must be a valid amount with up to 3 digits and 2 decimal places"},{"code":"INVALID_RANGE","field":"maxBidPrice","message":"Max Bid Price must be less than or equal to 999999999.99"},{"code":"INVALID_VALUE","field":"dollarAllocation","message":"Dollar Allocation must be a valid amount with up to 9 digits and 2 decimal places"},{"code":"INVALID_VALUE","field":"baseBidPrice","message":"Base Bid Price must be a valid amount with up to 9 digits and 2 decimal places"},{"code":"INVALID_RANGE","field":"priority","message":"Priority must less than or equal to 999"},{"code":"INVALID_RANGE","field":"percentAllocation","message":"Percent allocation must be less than or equal to 100.00"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:42:23.24961","path":"/RestApi/v2/tactic/{tacticId}","operation":"PUT","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"tacticId","message":"You do not have permission to access this Tactic.","value":205466}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-30T22:01:33.734282","path":"/RestApi/v2/tactic/{tacticId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"TACTIC_NOT_FOUND","message":"Tactic not found for the given id.","field":"tacticId","value":2054668}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"Tactic cannot be deleted":{"description":"Tactic cannot be deleted","value":{"success":false,"status":422,"timestamp":"2026-02-17T23:49:11.52214","requestId":"94144bb6-2c88-4624-b0d2-c40331c6d01c","path":"/RestApi/v2/account/559145/tactics/212164","operation":"DELETE","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"TACTIC_HAS_BIDS","message":"Tactic cannot be deleted as it has already served impressions.","field":"tacticId","value":{"tacticId":212164}}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}},"patch":{"tags":["Campaign Management"],"summary":"Update Tactic","description":"This endpoint updates the details of a Tactic","operationId":"tactic_update","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tacticId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TacticRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TacticResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-30T22:12:19.87417","path":"/RestApi/v2/tactic/{tacticId}","operation":"PUT","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_VALUE","field":"percentAllocation","message":"Percent allocation must be a valid amount with up to 3 digits and 2 decimal places"},{"code":"INVALID_RANGE","field":"maxBidPrice","message":"Max Bid Price must be less than or equal to 999999999.99"},{"code":"INVALID_VALUE","field":"dollarAllocation","message":"Dollar Allocation must be a valid amount with up to 9 digits and 2 decimal places"},{"code":"INVALID_VALUE","field":"baseBidPrice","message":"Base Bid Price must be a valid amount with up to 9 digits and 2 decimal places"},{"code":"INVALID_RANGE","field":"priority","message":"Priority must less than or equal to 999"},{"code":"INVALID_RANGE","field":"percentAllocation","message":"Percent allocation must be less than or equal to 100.00"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:42:23.24961","path":"/RestApi/v2/tactic/{tacticId}","operation":"PUT","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"tacticId","message":"You do not have permission to access this Tactic.","value":205466}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-30T22:01:33.734282","path":"/RestApi/v2/tactic/{tacticId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"TACTIC_NOT_FOUND","message":"Tactic not found for the given id.","field":"tacticId","value":2054668}]}}}}}},"422":{"description":"Unprocessable Entity - Business Rule Violation","content":{"application/json":{"examples":{"BaseBidPrice cannot exceed MaxBidPrice":{"description":"BaseBidPrice cannot exceed MaxBidPrice","value":{"success":false,"status":422,"timestamp":"2025-10-30T22:22:53.066582","path":"/RestApi/v2/tactic/{tacticId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"BUDGET_EXCEEDED","message":"BaseBidPrice cannot exceed MaxBidPrice","field":"baseBidPrice","value":{"baseBidPrice":200,"maxBidPrice":100}}]}}},"Dollar Allocation cannot exceed LineItem Budget":{"description":"Dollar Allocation cannot exceed LineItem Budget","value":{"success":false,"status":422,"timestamp":"2025-10-30T22:29:21.419862","path":"/RestApi/v2/tactic/{tacticId}","operation":"PUT","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"BUDGET_EXCEEDED","message":"Dollar Allocation cannot exceed LineItem Budget","field":"dollarAllocation","value":{"lineItemBudget":50,"dollarAllocation":136}}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/account/{accountId}/campaigns/{campaignId}":{"get":{"tags":["Campaign Management"],"summary":"Get Campaign","description":"This endpoint returns the Campaign details of a given Campaign Id","operationId":"campaign_get_by_id","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"campaignId","in":"path","description":"Campaign Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignGroupResponse"}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:45:05.266094","path":"/RestApi/v2/campaign/{campaignId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"campaignId","message":"You do not have permission to access this Campaign.","value":105836}]}}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"success":false,"status":404,"timestamp":"2025-10-30T19:44:57.478786","path":"/RestApi/v2/campaign/{campaignId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"CAMPAIGN_NOT_FOUND","message":"Campaign not found for the given id.","field":"campaignId","value":1058365455}]}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}},"patch":{"tags":["Campaign Management"],"summary":"Update Campaign","description":"This endpoint updates the details of a Campaign","operationId":"campaign_update","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"campaignId","in":"path","description":"Campaign Id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignGroupRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignGroupResponse"}}}},"400":{"description":"Bad Request - Validation Error","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-30T19:51:10.801343","path":"/RestApi/v2/campaign/{campaignId}","operation":"PUT","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"REQUIRED_FIELD","field":"budgetCap","message":"Budget cap is required"}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:45:05.266094","path":"/RestApi/v2/campaign/{campaignId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"campaignId","message":"You do not have permission to access this Campaign.","value":105836}]}}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"success":false,"status":404,"timestamp":"2025-10-30T19:44:57.478786","path":"/RestApi/v2/campaign/{campaignId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"CAMPAIGN_NOT_FOUND","message":"Campaign not found for the given id.","field":"campaignId","value":1058365455}]}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/npi/npi-list/{npiListId}/lite":{"get":{"tags":["NPI List Management"],"summary":"Get NPI List without NPIs","description":"This endpoint returns the NPI List details without NPI numbers of a given NPI List Id","operationId":"npi_get_by_id_lite","parameters":[{"name":"npiListId","in":"path","description":"NPI List Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NPIGroupResponse"}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-31T16:25:36.416974","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"npiListId","message":"You do not have permission to access this NPI List.","value":42067}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T16:24:11.342602","path":"/RestApi/v2/{resource}","operation":"{HTTP_METHOD}","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"NPI_LIST_NOT_FOUND","message":"NPI List not found for the given id.","field":"npiListId","value":4206756345}]}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/meta/practitioners":{"get":{"tags":["Targeting Metadata"],"summary":"Get Practitioners","description":"Returns a paginated list of HCP (Health Care Professional) practitioner types. Supports cursor-based pagination (cursor/limit). Results can be filtered by a free-text search on practitioner name and sorted by name or id.","operationId":"hcp_practitioners_get_meta","parameters":[{"name":"cursor","in":"query","description":"Opaque pagination cursor from a previous response. Provide the next_cursor value to get the next page.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of results per page","required":false,"schema":{"type":"string","default":"50"},"example":50},{"name":"search","in":"query","description":"Free-text search across practitioner type names","required":false,"schema":{"type":"string"},"example":"Physician"},{"name":"sort","in":"query","description":"Sort field. Allowed values: name, id","required":false,"schema":{"type":"string","default":"id","enum":["name","id"]},"example":"name"}],"responses":{"200":{"description":"Ok - Returns a paginated list of practitioner types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HcpPractitionersSearchPagedResponse"}}}},"400":{"description":"Bad Request - Invalid query parameters","content":{"application/json":{"examples":{"INVALID_VALUE":{"description":"INVALID_VALUE","value":{"success":false,"status":400,"timestamp":"2026-04-14T09:14:34.018427","requestId":"df5a20d2-8390-4117-a2a8-df665f749206","path":"/RestApi/v2/meta/practitioners","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_VALUE","message":"Invalid sort parameter. Only 'name' or 'id' is allowed.","field":"sort"}]}}},"INVALID_TYPE":{"description":"INVALID_TYPE","value":{"success":false,"status":400,"timestamp":"2026-04-14T09:17:28.440691","requestId":"527749c3-a641-4d81-a00c-fb07d7bab585","path":"/RestApi/v2/meta/practitioners","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_TYPE","message":"Parameter 'limit' is invalid. Expected type: Integer","field":"limit","expected":"Integer"}]}}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/meta/healthTaxonomy":{"get":{"tags":["Targeting Metadata"],"summary":"Get Health Taxonomy Segments","description":"Returns MeSH-based health taxonomy segments (conditions and treatments) with their targeting availability across PulsePoint's targeting methods. This endpoint consolidates all health taxonomy discovery into a single call, allowing clients to understand which segments are available for audience vs contextual targeting and which specific targeting methods support each segment.","operationId":"health_taxonomy_get_meta","parameters":[{"name":"segmentType","in":"query","description":"Filter by segment type. Options: condition, treatment. Supports comma-separated values. Default: all types.","required":false,"schema":{"type":"string"},"example":"condition"},{"name":"targetingType","in":"query","description":"Filter by targeting availability. Options: audience, contextual. Supports comma-separated values. Default: all types.","required":false,"schema":{"type":"string"},"example":"audience"},{"name":"targetingMethod","in":"query","description":"Filter by specific targeting method. Options: healthPopulations, keywordPopulations, healthJourneyPlus, healthPages, sensitiveAreas, inCondition, keywords. Default: all methods.","required":false,"schema":{"type":"string"},"example":"healthPopulations"},{"name":"meshCode","in":"query","description":"Filter by specific MeSH code(s). Supports comma-separated values. Maximum 100 values allowed.","required":false,"schema":{"type":"string"},"example":"D003920,C01"},{"name":"search","in":"query","description":"Free text search across segment name and description. Minimum 3 characters.","required":false,"schema":{"type":"string"},"example":"diabetes"},{"name":"cursor","in":"query","description":"Opaque pagination cursor from a previous response.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of results per page. Use -1 to return all results. Default: 50.","required":false,"schema":{"type":"string","default":"50"},"example":50},{"name":"sort","in":"query","description":"Sort field. Options: name, meshCode, segmentType. Default: name","required":false,"schema":{"type":"string","default":"name"},"example":"name"},{"name":"order","in":"query","description":"Sort direction: asc or desc. Default: asc","required":false,"schema":{"type":"string","default":"asc"},"example":"asc"}],"responses":{"200":{"description":"Ok — Returns paginated health taxonomy data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthTaxonomyResponse"}}}},"400":{"description":"Bad Request — Invalid query parameters","content":{"application/json":{"examples":{"INVALID_TYPE":{"description":"INVALID_TYPE","value":{"success":false,"status":400,"timestamp":"2026-04-20T22:02:57.335263","requestId":"e7eb8286-038e-4626-a7ba-8e2e26361221","path":"/RestApi/v2/meta/healthTaxonomy","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_TYPE","message":"Parameter 'limit' has invalid value. Expected type: Integer","field":"limit","expected":"Integer"}]}}},"INVALID_VALUE":{"description":"INVALID_VALUE","value":{"success":false,"status":400,"timestamp":"2026-04-20T22:00:12.746131","requestId":"6efe437d-0b19-4f07-81aa-42ff8717ef0b","path":"/RestApi/v2/meta/healthTaxonomy","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_VALUE","message":"Invalid 'sort'. Allowed values: name, meshCode, segmentType","field":"sort"}]}}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/meta/healthSpecialties":{"get":{"tags":["Targeting Metadata"],"summary":"Get Health Specialties","description":"Returns a paginated list of HCP health specialties organized in a two-tier hierarchy (primary specialties and subspecialties). Supports filtering by tier, parent ID, group ID, free-text search, and specialty type (primary vs subspecialty). Results can be grouped by specialty_group or tier, and expanded with related specialties sharing the same group. When export=true, the full result set is returned as a downloadable file in JSON or CSV format.","operationId":"hcp_specialities_get_meta","parameters":[{"name":"tier","in":"query","description":"Specialty tier filter. Tier 1 = primary specialties, Tier 2 = subspecialties.","required":false,"schema":{"type":"string"},"example":1},{"name":"parent_id","in":"query","description":"Parent specialty ID to retrieve subspecialties under a specific primary specialty","required":false,"schema":{"type":"string"},"example":101},{"name":"include_children","in":"query","description":"When true, includes child subspecialties in the response","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Free-text search across specialty names","required":false,"schema":{"type":"string"},"example":"Cardiology"},{"name":"cursor","in":"query","description":"Opaque pagination cursor from a previous response. Provide the next_cursor value to get the next page.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of results per page (default: 50, max: 500)","required":false,"schema":{"type":"string","default":"50"},"example":50},{"name":"sort","in":"query","description":"Sort field. Allowed values: name, tier","required":false,"schema":{"type":"string","default":"name","enum":["name","tier"]},"example":"name"},{"name":"order","in":"query","description":"Sort direction: asc or desc","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"example":"asc"},{"name":"export","in":"query","description":"When true, returns a downloadable file instead of the standard JSON API response.","required":false,"schema":{"type":"string","default":"false"}},{"name":"format","in":"query","description":"Export format: json or csv","required":false,"schema":{"type":"string","default":"json","enum":["json","csv"]},"example":"csv"}],"responses":{"200":{"description":"Ok - Returns paginated health specialties data, or a downloadable file when export=true","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthSpecialtiesResponse"}}}},"400":{"description":"Bad Request - Invalid query parameters","content":{"application/json":{"examples":{"INVALID_VALUE":{"description":"INVALID_VALUE","value":{"success":false,"status":400,"timestamp":"2026-04-14T05:07:42.023005","requestId":"04105177-390c-4e2c-82d8-550943e63364","path":"/RestApi/v2/meta/healthSpecialties","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_VALUE","message":"tier must be 1 or 2","field":"tier"}]}}},"INVALID_TYPE":{"description":"INVALID_TYPE","value":{"success":false,"status":400,"timestamp":"2026-04-14T05:12:51.669354","requestId":"2fdb8d99-2640-4da3-bf25-a4423eb1425a","path":"/RestApi/v2/meta/healthSpecialties","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_TYPE","message":"Parameter 'limit' is invalid. Expected type: Integer","field":"limit","expected":"Integer"}]}}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"404":{"description":"Not Found - Parent specialty does not exist","content":{"application/json":{"examples":{"Parent specialty not found":{"description":"Parent specialty not found","value":{"success":false,"status":404,"timestamp":"2026-04-14T11:44:23.342499","requestId":"0e8c3481-d9c2-4dcc-9f25-2274381da02e","path":"/RestApi/v2/meta/healthSpecialties","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"PARENT_NOT_FOUND","message":"Parent specialty not found","field":"parent_id","value":99999999}]}}}}}}},"422":{"description":"Unprocessable Entity - Operation violates business rules","content":{"application/json":{"examples":{"INVALID_PARAMETER":{"description":"INVALID_PARAMETER","value":{"success":false,"status":422,"timestamp":"2026-04-14T00:57:43.061687","requestId":"21a5665b-ed66-4273-b4f0-fd03daed5aca","path":"/RestApi/v2/meta/healthSpecialties","operation":"GET","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_PARAMETER","message":"include_children can be true when tier=1","field":"include_children","value":{"include_children":true,"tier":2}}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/meta/geotargeting":{"get":{"tags":["Targeting Metadata"],"summary":"Get Geo-Targeting Options","description":"Returns a list of geographic targeting options with cursor-based pagination. Results can be filtered by type (country, state, city, metro), parent ISO code, country, state, free-text search, or specific ISO code. Supports bulk export in JSON or CSV format. When export=true, the response is streamed as a file attachment in batches of 20,000 records.","operationId":"geo_targets_get_meta","parameters":[{"name":"type","in":"query","description":"Geo-target type filter. Allowed values: country, state, city, metro","required":false,"schema":{"type":"string","enum":["country","state","city","metro"]},"example":"country"},{"name":"parent_iso","in":"query","description":"ISO code of the parent geo-target to scope results under (e.g., 'US' to get US states)","required":false,"schema":{"type":"string"},"example":"US"},{"name":"country","in":"query","description":"Country ISO code filter","required":false,"schema":{"type":"string"},"example":"usa"},{"name":"state","in":"query","description":"State ISO code filter","required":false,"schema":{"type":"string"},"example":"ak"},{"name":"search","in":"query","description":"Free-text search across geo-target names","required":false,"schema":{"type":"string"},"example":"alabama"},{"name":"iso_code","in":"query","description":"Look up a specific geo-target by its ISO code","required":false,"schema":{"type":"string"},"example":"ar"},{"name":"cursor","in":"query","description":"Opaque pagination cursor from a previous response. Provide the next_cursor value to get the next page.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of results per page","required":false,"schema":{"type":"string","default":"50"},"example":50},{"name":"sort","in":"query","description":"Sort field. Allowed values: sequence, name","required":false,"schema":{"type":"string","enum":["sequence","name"]},"example":"name"},{"name":"order","in":"query","description":"Sort direction: asc or desc","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"example":"asc"},{"name":"export","in":"query","description":"When true, triggers file-download mode.","required":false,"schema":{"type":"string","default":"false"},"example":false},{"name":"format","in":"query","description":"Export format: json or csv","required":false,"schema":{"type":"string","default":"json","enum":["json","csv"]},"example":"csv"}],"responses":{"200":{"description":"Ok - Returns paginated geo-targeting data, or a streamed file when export=true","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoTargetingResponse"}}}},"400":{"description":"Bad Request - Invalid query parameters","content":{"application/json":{"examples":{"INVALID_TYPE":{"description":"INVALID_TYPE","value":{"success":false,"status":400,"timestamp":"2026-04-14T01:12:59.260942","requestId":"7daccac1-91c7-441f-9e7c-8998ddd23bad","path":"/RestApi/v2/meta/geotargeting","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_TYPE","message":"Parameter 'export' is invalid. Expected type: Boolean","field":"export","expected":"Boolean"}]}}},"INVALID_VALUE":{"description":"INVALID_VALUE","value":{"success":false,"status":400,"timestamp":"2026-04-14T01:19:52.880968","requestId":"8442bcc5-558d-4523-a7cb-04df6fc54cf2","path":"/RestApi/v2/meta/geotargeting","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_VALUE","message":"Invalid 'format'. Allowed values: json, csv","field":"format"}]}}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"422":{"description":"Unprocessable Entity - Operation violates business rules","content":{"application/json":{"examples":{"Invalid parameter combination":{"description":"Invalid parameter combination","value":{"success":false,"status":422,"timestamp":"2026-04-14T00:53:24.953106","requestId":"7ab500ab-6eb9-4d52-9453-f253925bb9af","path":"/RestApi/v2/meta/geotargeting","operation":"GET","error":{"code":"BUSINESS_RULE_VIOLATION","message":"Operation violates business rules.","details":[{"code":"INVALID_PARAMETER_COMBINATION","message":"Cannot fetch country when country code is passed.","field":"country","value":{"type":"country","country":"usa"}}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/meta/brandSuitabilityCategories":{"get":{"tags":["Targeting Metadata"],"summary":"Get Brand Suitability Categories","description":"Returns a merged list of brand suitability categories from DV and IAS providers with cursor-based pagination support. Supports hierarchical navigation, search, leaf-only filtering, and export.","operationId":"brand_suitability_categories_get_meta","parameters":[{"name":"parentId","in":"query","description":"Filter categories by parent category ID (DB id of the parent category)","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"search","in":"query","description":"Search across category names (case-insensitive partial match)","required":false,"schema":{"type":"string"}},{"name":"leafOnly","in":"query","description":"Return only leaf nodes — directly targetable categories (default: false)","required":false,"schema":{"type":"boolean","default":false}},{"name":"cursor","in":"query","description":"Cursor for pagination. Provide the cursor from the previous response to get the next page.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of results per page (default: 50, max: 100). Use -1 to return all records in a single response.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"providerId","in":"query","description":"Filter by providerId: DV or IAS (optional, returns all providers when omitted)","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort field: name, id, parentId (default: name)","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort direction: asc or desc (default: asc)","required":false,"schema":{"type":"string"}},{"name":"export","in":"query","description":"Return export format (default: false)","required":false,"schema":{"type":"boolean","default":false}},{"name":"format","in":"query","description":"Export format: json or csv (default: json)","required":false,"schema":{"type":"string","default":"json"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandSuitabilityCategoriesResponse"}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"examples":{"Invalid parameters":{"description":"Invalid parameters","value":{"success":false,"status":400,"timestamp":"2026-03-16T22:27:09.238284","requestId":"2a8a58db-e63d-4eae-9a39-2791a7589187","path":"/RestApi/v2/meta/brandSuitabilityCategories","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_VALUE","message":"providerId must be either 'DV' or 'IAS'","field":"providerId"}]}}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/meta/behavioralSegments":{"get":{"tags":["Targeting Metadata"],"summary":"Get Behavioral Segments","description":"This endpoint returns a list of behavioral segments for a given account ID with cursor-based pagination support. You can filter segments by search name, data provider, size and CPM cost.","operationId":"behavioral_segments_get_account_id","parameters":[{"name":"accountId","in":"query","description":"Account ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"search","in":"query","description":"Search across segment names","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor for pagination. Provide the cursor from the previous response to get the next page.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of results per page (default: 50, max: 100)","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"providers","in":"query","description":"Comma-separated list of Data Provider IDs","required":false,"schema":{"type":"string"}},{"name":"min_size","in":"query","description":"Minimum segment size","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"max_size","in":"query","description":"Maximum segment size","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"min_cpm","in":"query","description":"Minimum CPM cost filter","required":false,"schema":{"type":"number","format":"double"}},{"name":"max_cpm","in":"query","description":"Maximum CPM cost filter","required":false,"schema":{"type":"number","format":"double"}},{"name":"sort","in":"query","description":"Sort field: name, size, cpm, provider","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort order: asc or desc (default: asc)","required":false,"schema":{"type":"string"}},{"name":"export","in":"query","description":"Return export format","required":false,"schema":{"type":"boolean","default":false}},{"name":"format","in":"query","description":"Export format: json or csv (default: json)","required":false,"schema":{"type":"string","default":"json"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BehavioralSegmentsResponse"}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"examples":{"Invalid account ID format":{"description":"Invalid account ID format","value":{"success":false,"status":400,"timestamp":"2026-02-16T10:30:15.123456","path":"/RestApi2/v2/meta/behavioralSegments","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_FORMAT","field":"accountId","message":"Account ID must be a valid number","value":"abc123"}]}}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"examples":{"Account access denied":{"description":"Account access denied","value":{"success":false,"status":403,"timestamp":"2026-02-16T10:35:45.789012","path":"/RestApi2/v2/meta/behavioralSegments","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","message":"You do not have permission to access this account","value":{"accountId":111222}}]}}},"Read permission error":{"description":"Read permission error","value":{"success":false,"status":403,"timestamp":"2026-02-16T10:38:12.345678","path":"/RestApi2/v2/meta/behavioralSegments","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","message":"User does not have read permission for behavioral segments on this account","field":"accountId","value":111111}]}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"Segments not found":{"description":"Segments not found","value":{"success":false,"status":404,"timestamp":"2026-02-16T10:42:55.123456","path":"/RestApi2/v2/meta/behavioralSegments","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"NO_SEGMENTS_FOUND","message":"No behavioral segments found matching the specified criteria","value":{"accountId":559145,"searchTerm":"nonexistent","dataProviderId":12345}}]}}}}}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"examples":{"Rate limit exceeded":{"description":"Rate limit exceeded","value":{"success":false,"status":429,"timestamp":"2026-02-25T14:20:30.123456","path":"/RestApi2/v2/meta/behavioralSegments","operation":"GET","error":{"code":"RATE_LIMIT_EXCEEDED","message":"API rate limit exceeded","details":[{"code":"TOO_MANY_REQUESTS","message":"You have exceeded the rate limit for this endpoint","value":{"limit":100,"current":100,"window":60},"resetAt":"2026-02-25T14:21:30.123456Z","retryAfter":60}]}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/campaignImport/{campaignId}":{"get":{"tags":["Campaign Import"],"summary":"Get Campaign","description":"This endpoint returns the Campaign details along with the Line Items of a given active Campaign Id","operationId":"campaign_import_get_by_id","parameters":[{"name":"campaignId","in":"path","description":"Campaign Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignImportResponse"}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"examples":{"Account access error":{"description":"Account access error","value":{"success":false,"status":403,"timestamp":"2025-10-31T20:20:23.841778","path":"/RestApi/v2/campaignImport/{campaignId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","message":"User does not have campaign import permission on this account.","value":{"accountId":559145}}]}}},"Read Write permission error":{"description":"Read Write permission error","value":{"success":false,"status":403,"timestamp":"2025-10-31T20:23:31.156669","path":"/RestApi/v2/campaignImport/{campaignId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"campaignId","message":"User doesn't have read campaign or create campaign permission on this account."}]}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T20:13:12.827674","path":"/RestApi/v2/campaignImport/{campaignId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"CAMPAIGN_NOT_FOUND","message":"Campaign not found for the given id.","field":"campaignId","value":"1071375454"}]}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/campaignImport/lineItem/{lineItemId}":{"get":{"tags":["Campaign Import"],"summary":"Get Line Item","description":"This endpoint returns the Line Item details along with the Tactics of a given Line Item Id.","operationId":"lineitem_import_get_by_id","parameters":[{"name":"lineItemId","in":"path","description":"LineItem Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemImportResponse"}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"examples":{"Lineitem inventory access denied":{"description":"Lineitem inventory access denied","value":{"success":false,"status":403,"timestamp":"2025-10-31T20:36:26.4081","path":"/RestApi/v2/campaignImport/lineItem/{lineItemId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"lineItemId","message":"User does not have permissions for LineItem inventory type","value":117616}]}}},"Campaign import permission error":{"description":"Campaign import permission error","value":{"success":false,"status":403,"timestamp":"2025-10-31T20:39:45.961713","path":"/RestApi/v2/campaignImport/lineItem/{lineItemId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","message":"User does not have campaign import permission on this account.","value":{"accountId":559145}}]}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T20:37:41.319046","path":"/RestApi/v2/campaignImport/lineItem/{lineItemId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"LINE_ITEM_NOT_FOUND","message":"Line Item not found for the given id.","field":"lineItemId","value":1176163434}]}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/campaignImport/advertiser/{advertiserId}/account/{accountId}":{"get":{"tags":["Campaign Import"],"summary":"Get Campaigns by Account and Advertiser","description":"This endpoint returns a list of Campaign Ids under an Account Id and Advertiser Id","operationId":"campaign_import_get_advertiser_campaigns_by_account_id","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"advertiserId","in":"path","description":"Advertiser Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"enabled","in":"query","description":"Flag to filter enabled/disabled campaigns. Default is false if not provided.","required":false,"schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvertiserCampaignResponse"}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-31T20:39:45.961713","path":"/RestApi/v2/campaignImport/lineItem/{lineItemId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","message":"User does not have campaign import permission on this account.","value":{"accountId":559145}}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T21:05:15.583523","path":"/RestApi/v2/campaignImport/advertiser/{advertiserId}/account/{accountId}","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"NOT_FOUND","message":"Advertiser Id or Account Id is invalid","value":{"advertiserId":12054,"accountId":5591455}}]}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/campaignImport/account/{accountId}/advertisers":{"get":{"tags":["Campaign Import"],"summary":"Get Advertisers by Account","description":"This endpoint returns Advertiser IDs of a given Account Id","operationId":"campaign_import_get_advertisers_by_account_id","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountAdvertiserResponse"}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-31T20:39:45.961713","path":"/RestApi/v2/campaignImport/lineItem/{lineItemId}","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","message":"User does not have campaign import permission on this account.","value":{"accountId":559145}}]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-31T21:01:29.243609","path":"/RestApi/v2/campaignImport/account/{accountId}/advertisers","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"NOT_FOUND","message":"Advertisers not found for the given Account Id.","field":"accountId","value":559145}]}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/account/{accountId}/pixels":{"get":{"tags":["Account Assets"],"summary":"Get Pixels","description":"Returns a cursor-paginated list of pixels (retargeting, conversion, and/or smart) for a given account. Results are ordered: retargeting pixels first (sorted by id), then conversion pixels (sorted by id), and then smart pixels (sorted by id). Use the nextCursor from the response pagination to fetch subsequent pages.","operationId":"pixels_get_by_account_id","parameters":[{"name":"accountId","in":"path","description":"Account ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"advertiser_id","in":"query","description":"Filter by advertiser ID","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"type","in":"query","description":"Filter by pixel type. Allowed values: retargeting, conversion, smart","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Opaque cursor string returned by a previous page response. When provided, fetches the next page of results after the cursor position.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of results to return per page (default: 50, max: 100)","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixelListResponse"}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"examples":{"Invalid pixel type":{"description":"Invalid pixel type","value":{"success":false,"status":400,"timestamp":"2026-02-16T10:30:15.123456","path":"/RestApi/v2/account/1/pixels","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_PIXEL_TYPE","field":"type","message":"Pixel type must be one of: retargeting, conversion, smart","expected":"One of: retargeting, conversion, smart"}]}}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Access Denied","content":{"application/json":{"examples":{"Account access denied":{"description":"Account access denied","value":{"success":false,"status":403,"timestamp":"2026-02-16T10:35:45.789012","path":"/RestApi/v2/account/1/pixels","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","message":"You do not have permission to access this account","value":{"accountId":323455}}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}},"/v2/account/{accountId}/creatives":{"get":{"tags":["Account Assets"],"summary":"Get creatives for account","description":"Returns creatives for an account filtered by advertiser_id. Uses cursor-based paging: pass cursor and limit for subsequent pages.","operationId":"creatives_get_by_account_id","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"advertiser_id","in":"query","description":"Advertiser Id (required)","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"cursor","in":"query","description":"Opaque cursor for next page (from previous response next_cursor)","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Page size (default 50, max 100)","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCreativesResponse"}}}},"400":{"description":"Bad Request - Missing or structurally invalid request parameters (e.g. advertiser_id required)","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":400,"timestamp":"2025-10-30T22:57:54.246591","path":"/RestApi2/v2/account/{accountId}/creatives","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"REQUIRED_PARAMETER_MISSING","field":"advertiser_id","message":"Required request parameter 'advertiser_id' is not present or invalid."}]}}}}}},"401":{"description":"Unauthorized - Invalid or expired access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnAuthorizedResponse"}}}},"403":{"description":"Forbidden - User does not have permission to access this account","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":403,"timestamp":"2025-10-30T22:56:31.960991","path":"/RestApi2/v2/account/{accountId}/creatives","operation":"GET","error":{"code":"ACCESS_DENIED","message":"Access to this resource is denied.","details":[{"code":"INSUFFICIENT_PERMISSIONS","field":"accountId","message":"You do not have permission to access this Account.","value":12345}]}}}}}},"404":{"description":"Not Found - Advertiser not found for the given advertiser_id","content":{"application/json":{"schema":{"type":"string","example":{"success":false,"status":404,"timestamp":"2025-10-30T22:59:34.707588","path":"/RestApi2/v2/account/{accountId}/creatives","operation":"GET","error":{"code":"RESOURCE_NOT_FOUND","message":"Requested resource not found.","details":[{"code":"ADVERTISER_NOT_FOUND","message":"Advertiser not found for the given Advertiser Id.","field":"advertiserId","value":5555}]}}}}}},"422":{"description":"Unprocessable Entity - Business rule violation (e.g. invalid cursor value, limit outside 1-100 range)","content":{"application/json":{"examples":{"Invalid cursor":{"description":"Invalid cursor","value":{"success":false,"status":400,"timestamp":"2025-10-30T22:57:54.246591","path":"/RestApi2/v2/account/{accountId}/creatives","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_CURSOR","field":"cursor","message":"Invalid Cursor"}]}}},"Invalid limit":{"description":"Invalid limit","value":{"success":false,"status":400,"timestamp":"2025-10-30T22:57:54.246591","path":"/RestApi2/v2/account/{accountId}/creatives","operation":"GET","error":{"code":"VALIDATION_ERROR","message":"Request validation failed","details":[{"code":"INVALID_LIMIT_RANGE","field":"limit","message":"Valid range for limit is 1 to 100."}]}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitingResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}}}}},"components":{"schemas":{"ReplaceNPIsInNPIListRequest":{"required":["npis"],"type":"object","properties":{"npis":{"uniqueItems":true,"type":"array","example":["3137933127","3134730121"],"items":{"type":"string","example":"[\"3137933127\",\"3134730121\"]"}}}},"ErrorDetails":{"type":"object","properties":{"code":{"type":"string","example":"invalid_token"},"message":{"type":"string","description":"Detailed error message","example":"Invalid access token: abcdefg"},"recommendedAction":{"type":"string","description":"Recommended action to resolve the error","example":"Please obtain a new access_token using /oauth/token endpoint."}},"description":"Error details"},"UnAuthorizedResponse":{"type":"object","properties":{"success":{"type":"boolean","example":false},"status":{"type":"integer","description":"HTTP status code","format":"int32","example":401},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2025-12-10T19:06:45.850910"},"requestId":{"type":"string","description":"Unique Id to trace the error","example":"6b06801f-bbfd-41c3-97f8-bf764fb5017d"},"path":{"type":"string","description":"Request path that caused the error","example":"/RestApi/v2/{resource}"},"operation":{"type":"string","description":"HTTP operation method","example":"GET"},"error":{"$ref":"#/components/schemas/ErrorDetails"}}},"ReplaceNPIListData":{"type":"object","properties":{"listId":{"type":"integer","description":"NPI List ID","format":"int64","example":42104},"listName":{"type":"string","description":"Name of the NPI list","example":"NPI_42104"},"npisReplaced":{"type":"integer","description":"Number of NPIs replaced in the list.","format":"int64","example":25},"totalNpis":{"type":"integer","description":"Total number of NPIs in the list after the replace operation.","format":"int64","example":50}},"description":"NPI Group replace data"},"ReplaceNPIListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/ReplaceNPIListData"}}},"InternalServerError":{"type":"object","properties":{"code":{"type":"string","example":"INTERNAL_SERVER_ERROR"},"message":{"type":"string","example":"An unexpected error occurred while processing your request"},"details":{"type":"array","items":{"$ref":"#/components/schemas/InternalServerErrorDetail"}}}},"InternalServerErrorDetail":{"type":"object","properties":{"code":{"type":"string","example":"SYSTEM_ERROR"},"message":{"type":"string","example":"Our team has been notified and is investigating the issue"},"suggestedAction":{"type":"string","example":"Please try again in a few moments. If the issue persists, contact support."}}},"InternalServerErrorResponse":{"type":"object","properties":{"success":{"type":"boolean","example":false},"timestamp":{"type":"string","example":"2025-10-30T19:13:37.249963"},"requestId":{"type":"string","description":"Unique Id to trace the error","example":"6b06801f-bbfd-41c3-97f8-bf764fb5017d"},"path":{"type":"string","description":"The API endpoint that was accessed","example":"/RestApi/v2/{resource}"},"operation":{"type":"string","description":"The HTTP method used for the request like GET, POST, PUT, DELETE","example":"{HTTP_METHOD}"},"status":{"type":"integer","format":"int32","example":500},"error":{"$ref":"#/components/schemas/InternalServerError"}}},"RateLimitingDetail":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS"},"message":{"type":"string","example":"You have exceeded the rate limit for this endpoint"},"value":{"$ref":"#/components/schemas/RateLimitingValue"},"resetAt":{"type":"string","description":"The timestamp (UTC) at which the rate limit will reset","example":"2025-10-30T13:44:16.117Z"},"retryAfter":{"type":"integer","description":"The number of seconds to wait before making a new request","format":"int32","example":39}}},"RateLimitingError":{"type":"object","properties":{"code":{"type":"string","example":"RATE_LIMIT_EXCEEDED"},"message":{"type":"string","example":"API rate limit exceeded"},"details":{"type":"array","items":{"$ref":"#/components/schemas/RateLimitingDetail"}}}},"RateLimitingResponse":{"type":"object","properties":{"success":{"type":"boolean","example":false},"timestamp":{"type":"string","example":"2025-10-30T19:13:37.249963"},"requestId":{"type":"string","description":"Unique Id to trace the error","example":"6b06801f-bbfd-41c3-97f8-bf764fb5017d"},"path":{"type":"string","description":"The API endpoint that was accessed","example":"/RestApi/v2/{resource}"},"operation":{"type":"string","description":"The HTTP method used for the request like GET, POST, PUT, DELETE","example":"{HTTP_METHOD}"},"status":{"type":"integer","format":"int32","example":429},"error":{"$ref":"#/components/schemas/RateLimitingError"}}},"RateLimitingValue":{"type":"object","properties":{"limit":{"type":"integer","description":"The maximum number of requests allowed in the time window","format":"int32","example":5},"current":{"type":"integer","description":"The number of requests made in the current time window","format":"int32","example":5},"window":{"type":"integer","description":"The time window in seconds for the rate limit","format":"int32","example":60}}},"ReplaceAttributesInNPIListRequest":{"required":["attributeValues","attributes","npiColumnIndex"],"type":"object","properties":{"attributes":{"type":"array","description":"Column headers","example":["NPI_ID","Active","CampaignName"],"items":{"type":"string","description":"Column headers","example":"[\"NPI_ID\",\"Active\",\"CampaignName\"]"}},"attributeValues":{"type":"array","description":"value for corresponding attribute header per NPI","example":[["1639137706","yes","NPI Targeted Banners"]],"items":{"type":"array","description":"value for corresponding attribute header per NPI","example":[["1639137706","yes","NPI Targeted Banners"]],"items":{"type":"string","description":"value for corresponding attribute header per NPI","example":"[[\"1639137706\",\"yes\",\"NPI Targeted Banners\"]]"}}},"npiColumnIndex":{"minimum":0,"type":"integer","description":"which column contains NPIs (Starts with first column = 0)","format":"int32","example":0}}},"NPIGroupAttributeReplaceResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/NPIGroupAttributesReplaceResponseData"}}},"NPIGroupAttributesReplaceResponseData":{"type":"object","properties":{"listId":{"type":"integer","description":"NPI List ID","format":"int64","example":42104},"listName":{"type":"string","description":"Name of the NPI list","example":"NPI_with_Attr"},"npisReplaced":{"type":"integer","description":"Number of NPIs replaced in the list.","format":"int64","example":25},"rowsReplaced":{"type":"integer","description":"Number of NPI Attribute Rows replaced in the list.","format":"int64","example":12},"totalNpis":{"type":"integer","description":"Total number of NPIs in the list after the replace operation.","format":"int64","example":50},"totalRows":{"type":"integer","description":"Total number of NPI Attribute rows in the list after the replace operation.","format":"int64","example":55}},"description":"NPI List Attribute Replace data"},"HtmlCreativeRequest":{"required":["adChoicesIcon","adSizeHeight","adSizeWidth","advertiserName","creativeHtml","creativeType","domainLandingPage","name"],"type":"object","properties":{"name":{"maxLength":80,"minLength":1,"type":"string","example":"testApr-10"},"advertiserName":{"type":"string","example":"01- Advertiser"},"adSizeWidth":{"type":"integer","format":"int32","example":1024},"adSizeHeight":{"type":"integer","format":"int32","example":576},"domainLandingPage":{"maxLength":1024,"minLength":0,"pattern":"https?://.*","type":"string","example":"https://test.com/"},"adChoicesIcon":{"type":"string","example":"TopRight","enum":["TopRight","TopLeft","BottomRight","BottomLeft","None"]},"notes":{"type":"string","example":"test-notes"},"placementId":{"type":"integer","format":"int64","example":123},"campaignRestrictName":{"type":"string","example":"camp1_drug"},"categoryNames":{"type":"array","example":["Family & Parenting","Personal Finance"],"items":{"type":"string","example":"[\"Family & Parenting\",\"Personal Finance\"]"}},"dsaAdvertiser":{"type":"string","description":"DSA Advertiser name is required if DSA is enabled for the Account.","example":"DSA Advertiser"},"financer":{"type":"string","description":"DSA Financer name is required if DSA is enabled for the Account.","example":"DSA Financer"},"creativeType":{"type":"string","example":"html","enum":["html"]},"creativeHtml":{"type":"string","description":"HTML content of the creative","example":"test-html"}}},"ExpandableHtmlCreativeRequest":{"required":["adChoicesIcon","adSizeHeight","adSizeWidth","advertiserName","creativeHtml","creativeType","domainLandingPage","expandDirection","name"],"type":"object","properties":{"name":{"maxLength":80,"minLength":1,"type":"string","example":"testApr-10"},"advertiserName":{"type":"string","example":"01- Advertiser"},"adSizeWidth":{"type":"integer","format":"int32","example":1024},"adSizeHeight":{"type":"integer","format":"int32","example":576},"domainLandingPage":{"maxLength":1024,"minLength":0,"pattern":"https?://.*","type":"string","example":"https://test.com/"},"adChoicesIcon":{"type":"string","example":"TopRight","enum":["TopRight","TopLeft","BottomRight","BottomLeft","None"]},"notes":{"type":"string","example":"test-notes"},"placementId":{"type":"integer","format":"int64","example":123},"campaignRestrictName":{"type":"string","example":"camp1_drug"},"categoryNames":{"type":"array","example":["Family & Parenting","Personal Finance"],"items":{"type":"string","example":"[\"Family & Parenting\",\"Personal Finance\"]"}},"dsaAdvertiser":{"type":"string","description":"DSA Advertiser name is required if DSA is enabled for the Account.","example":"DSA Advertiser"},"financer":{"type":"string","description":"DSA Financer name is required if DSA is enabled for the Account.","example":"DSA Financer"},"creativeType":{"type":"string","enum":["expandable"]},"creativeHtml":{"type":"string","description":"HTML content of the creative","example":"<div><p>test</p></div> \n<script>src</script>"},"expandDirection":{"type":"string","description":"Expandable type","enum":["Up","Down","Left","Right","Up Left","Up Right","Down Left","Down Right"]}}},"VideoCreativeRequest":{"required":["adChoicesIcon","adSizeHeight","adSizeWidth","advertiserName","clickThroughURL","creativeType","domainLandingPage","duration","name","source","type","videoURL"],"type":"object","properties":{"name":{"maxLength":80,"minLength":1,"type":"string","example":"testApr-10"},"advertiserName":{"type":"string","example":"01- Advertiser"},"adSizeWidth":{"type":"integer","format":"int32","example":1024},"adSizeHeight":{"type":"integer","format":"int32","example":576},"domainLandingPage":{"maxLength":1024,"minLength":0,"pattern":"https?://.*","type":"string","example":"https://test.com/"},"adChoicesIcon":{"type":"string","example":"TopRight","enum":["TopRight","TopLeft","BottomRight","BottomLeft","None"]},"notes":{"type":"string","example":"test-notes"},"placementId":{"type":"integer","format":"int64","example":123},"campaignRestrictName":{"type":"string","example":"camp1_drug"},"categoryNames":{"type":"array","example":["Family & Parenting","Personal Finance"],"items":{"type":"string","example":"[\"Family & Parenting\",\"Personal Finance\"]"}},"dsaAdvertiser":{"type":"string","description":"DSA Advertiser name is required if DSA is enabled for the Account.","example":"DSA Advertiser"},"financer":{"type":"string","description":"DSA Financer name is required if DSA is enabled for the Account.","example":"DSA Financer"},"creativeType":{"type":"string","enum":["video"]},"source":{"type":"string","description":"Possible combinations: VAST_Doc (when type is HTML5_VPAID or MP4_VIDEO),\n VAST_URL (when type is HTML5_VPAID or MP4_VIDEO),\n URL (when type is FLV, MP4_VIDEO) ","example":"VAST_Doc","enum":["VAST_Doc","VAST_URL","URL"]},"type":{"type":"string","example":"HTML5_VPAID","enum":["HTML5_VPAID","MP4_VIDEO","FLV"]},"duration":{"type":"integer","description":"Duration of the video in seconds","format":"int32","example":30},"clickThroughURL":{"pattern":"https?://.*","type":"string","description":"Click-through URL for the video","example":"https://click.test.com"},"bitRate":{"type":"integer","description":"Video bit rate","format":"int32","example":20},"videoURL":{"pattern":"https?://.*","type":"string","description":"URL to the video asset","example":"https://rtr.innovid.com/r1.656e48c6baa313.39895082;cb=[timestamp]"},"videoSkippingAfter":{"type":"integer","description":"Seconds before skip button appears","format":"int32","example":5}}},"HTML5CreativeClicksData":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"clickUrl":{"type":"string"}}},"HTMLCreativeData":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":12345},"name":{"type":"string","example":"creative abc"},"advertiserName":{"type":"string","example":"01- Advertiser"},"adSizeWidth":{"type":"integer","format":"int32","example":1024},"adSizeHeight":{"type":"integer","format":"int32","example":576},"domainLandingPage":{"type":"string","example":"https://test.com/"},"adChoicesIcon":{"type":"string","example":"TopRight","enum":["TopRight","TopLeft","BottomRight","BottomLeft","None"]},"obaIconOnly":{"type":"boolean","example":false},"accountId":{"type":"integer","format":"int64","example":12345},"categoryNames":{"type":"array","example":["Family & Parenting","Personal Finance"],"items":{"type":"string","example":"[\"Family & Parenting\",\"Personal Finance\"]"}},"notes":{"type":"string","example":"this is for abc "},"campaignRestrictName":{"type":"string","example":"camp1_drug"},"placementId":{"type":"integer","format":"int64","example":123},"approvalStatus":{"type":"string","example":"Approved","enum":["PendingApproval","Approved","Denied"]},"denialReason":{"type":"string","example":"Not valid creative"},"userAccountId":{"type":"integer","format":"int64","example":5678},"advertiserId":{"type":"integer","format":"int64","example":345},"dsaAdvertiser":{"type":"string","example":"DSA_Advertiser_Name"},"financer":{"type":"string","example":"Financer_Name"},"creativeType":{"type":"string","description":"Type of the creative.","enum":["html"]},"adFormat":{"type":"string","example":"GenericHtml","enum":["Image","Flash","GenericHtml","ExpandableRichMedia","Redirect","WildCard","Native","Video","Search","Audio","Legacy","NativeVideo"]},"creativeHtml":{"type":"string","description":"HTML content of the creative","example":"<div><p>test</p></div> \n<script>src</script>"},"html5":{"type":"boolean","description":"Indicates if the creative is HTML5","example":true},"html5Clicks":{"type":"array","description":"List of click tags for HTML5 creative","items":{"$ref":"#/components/schemas/HTML5CreativeClicksData"}}},"description":"HTML Creative data"},"HtmlCreativeResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/HTMLCreativeData"}}},"ExpandableHtmlCreativeData":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":12345},"name":{"type":"string","example":"creative abc"},"advertiserName":{"type":"string","example":"01- Advertiser"},"adSizeWidth":{"type":"integer","format":"int32","example":1024},"adSizeHeight":{"type":"integer","format":"int32","example":576},"domainLandingPage":{"type":"string","example":"https://test.com/"},"adChoicesIcon":{"type":"string","example":"TopRight","enum":["TopRight","TopLeft","BottomRight","BottomLeft","None"]},"obaIconOnly":{"type":"boolean","example":false},"accountId":{"type":"integer","format":"int64","example":12345},"categoryNames":{"type":"array","example":["Family & Parenting","Personal Finance"],"items":{"type":"string","example":"[\"Family & Parenting\",\"Personal Finance\"]"}},"notes":{"type":"string","example":"this is for abc "},"campaignRestrictName":{"type":"string","example":"camp1_drug"},"placementId":{"type":"integer","format":"int64","example":123},"approvalStatus":{"type":"string","example":"Approved","enum":["PendingApproval","Approved","Denied"]},"denialReason":{"type":"string","example":"Not valid creative"},"userAccountId":{"type":"integer","format":"int64","example":5678},"advertiserId":{"type":"integer","format":"int64","example":345},"dsaAdvertiser":{"type":"string","example":"DSA_Advertiser_Name"},"financer":{"type":"string","example":"Financer_Name"},"creativeType":{"type":"string","description":"Type of the creative.","enum":["expandable"]},"adFormat":{"type":"string","example":"ExpandableRichMedia","enum":["Image","Flash","GenericHtml","ExpandableRichMedia","Redirect","WildCard","Native","Video","Search","Audio","Legacy","NativeVideo"]},"creativeHtml":{"type":"string","description":"HTML content of the creative","example":"<div><p>test</p></div> \n<script>src</script>"},"expandDirection":{"type":"string","description":"Expandable type","enum":["Up","Down","Left","Right","Up Left","Up Right","Down Left","Down Right"]},"html5":{"type":"boolean","description":"Indicates if the creative is HTML5","example":false},"html5Clicks":{"type":"array","items":{"$ref":"#/components/schemas/HTML5CreativeClicksData"}}},"description":"Expandable Creative data"},"ExpandableHtmlCreativeResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/ExpandableHtmlCreativeData"}}},"VideoCreativeData":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":12345},"name":{"type":"string","example":"creative abc"},"advertiserName":{"type":"string","example":"01- Advertiser"},"adSizeWidth":{"type":"integer","format":"int32","example":1024},"adSizeHeight":{"type":"integer","format":"int32","example":576},"domainLandingPage":{"type":"string","example":"https://test.com/"},"adChoicesIcon":{"type":"string","example":"TopRight","enum":["TopRight","TopLeft","BottomRight","BottomLeft","None"]},"obaIconOnly":{"type":"boolean","example":false},"accountId":{"type":"integer","format":"int64","example":12345},"categoryNames":{"type":"array","example":["Family & Parenting","Personal Finance"],"items":{"type":"string","example":"[\"Family & Parenting\",\"Personal Finance\"]"}},"notes":{"type":"string","example":"this is for abc "},"campaignRestrictName":{"type":"string","example":"camp1_drug"},"placementId":{"type":"integer","format":"int64","example":123},"approvalStatus":{"type":"string","example":"Approved","enum":["PendingApproval","Approved","Denied"]},"denialReason":{"type":"string","example":"Not valid creative"},"userAccountId":{"type":"integer","format":"int64","example":5678},"advertiserId":{"type":"integer","format":"int64","example":345},"dsaAdvertiser":{"type":"string","example":"DSA_Advertiser_Name"},"financer":{"type":"string","example":"Financer_Name"},"creativeType":{"type":"string","description":"Type of the creative.","enum":["video"]},"source":{"type":"string","example":"VAST_URL"},"type":{"type":"string","example":"HTML5_VPAID"},"duration":{"type":"integer","format":"int32","example":9},"clickThroughURL":{"type":"string","example":"https://click.test.com"},"bitRate":{"type":"integer","format":"int32","example":20},"videoURL":{"type":"string","example":"https://rtr.innovid.com/r1.656e48c6baa313.39895082;cb=[timestamp]"},"videoSkippingAfter":{"type":"integer","format":"int32","example":10}}},"VideoCreativeResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/VideoCreativeData"}}},"AssignCreativeRequest":{"required":["tacticId"],"type":"object","properties":{"tacticId":{"type":"integer","description":"Number (A Valid Tactic ID)","format":"int64","example":12345},"creativesToAssign":{"type":"array","description":"Array of Numbers (A Valid Creative ID)","example":[207581,213282],"items":{"type":"integer","description":"Array of Numbers (A Valid Creative ID)","format":"int32"}},"creativesToUnAssign":{"type":"array","description":"Array of Numbers (A Valid Creative ID)","example":[207561,213290],"items":{"type":"integer","description":"Array of Numbers (A Valid Creative ID)","format":"int32"}}}},"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"}}},"CustomFieldSettingRequest":{"required":["fieldName","fieldValue","isNewField"],"type":"object","properties":{"isNewField":{"type":"boolean","example":true,"enum":[true,false]},"fieldName":{"maxLength":100,"minLength":1,"type":"string","description":"Field identifier. Name must be unique if isNewField = true","example":"New Custom Field Campaign REST"},"fieldValue":{"maxLength":500,"minLength":1,"type":"string","example":"custom field value"}},"description":"Custom field configurations for the line item"},"FlightRequest":{"required":["budget","endDate","pacingMode","startDate"],"type":"object","properties":{"id":{"type":"integer","description":"ID of the flight to update. If not provided, a new flight will be created.","format":"int64","example":12345},"budget":{"maximum":999999.99,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Flight Budget amount","format":"double","example":50},"startDate":{"type":"string","description":"Flight start datetime","example":"11-01-2025 00:00:00"},"endDate":{"type":"string","description":"Flight end datetime","example":"11-30-2025 22:59:59"},"pacingMode":{"type":"string","description":"Budget pacing strategy","example":"EVEN","enum":["EVEN","ASAP","AHEAD"]},"paceAheadPercent":{"maximum":99,"minimum":1,"type":"integer","description":"Pacing percentage modifier","format":"int32","example":99},"totalImpressionCap":{"maximum":999999999,"minimum":1,"type":"integer","description":"Total Impressions that can serve for a given flight.","format":"int32","example":5000},"dailyImpressionCap":{"maximum":999999999,"minimum":1,"type":"integer","description":"Total impressions that can serve per day on a given flight.","format":"int32","example":1000},"maxDailySpendOverride":{"$ref":"#/components/schemas/LineItemFlightMaxDailySpendOverrideRequest"}},"description":"Break down campaign budgets into discrete time periods"},"FrequencyCapRequest":{"required":["applyFrequencyCap"],"type":"object","properties":{"applyFrequencyCap":{"type":"boolean","description":"Enable frequency capping","example":true},"times":{"maximum":100,"minimum":1,"type":"integer","description":"Impression limit. Required if applyFrequencyCap is true","format":"int32","example":9},"period":{"type":"string","description":"Time period. Required if applyFrequencyCap is true.","example":"day","enum":["day","hour(s)","week","month"]},"hoursValue":{"maximum":1000,"minimum":1,"type":"integer","description":"Custom hour period. Required if period=hour(s).","format":"int32","example":1},"crossDevice":{"type":"string","description":"Cross-device tracking. Required if applyFrequencyCap is true","example":"Per Device","enum":["Per Device","Per Person","Per Household"]},"untrackable":{"type":"boolean","description":"Include untrackable users","example":true},"ipUntrackable":{"type":"boolean","description":"Include IP-untrackable users","example":false}},"description":"Frequency capping settings for the line item. If not set, campaign frequency cap settings will be used across line items."},"LineItemDayPartingRequest":{"required":["enabled","schedule"],"type":"object","properties":{"enabled":{"type":"boolean","description":"If day parting isn't enabled, the line item will run the full day","example":true},"schedule":{"type":"array","description":"The schedule for day parting","items":{"$ref":"#/components/schemas/LineItemDayPartingScheduleRequest"}}},"description":"Dayparting settings for the line item."},"LineItemDayPartingScheduleRequest":{"required":["days","hours"],"type":"object","properties":{"days":{"type":"array","description":"What days the line item should run. Valid values: mon, tue, wed, thu, fri, sat, sun","example":["mon","tue","wed","thu","fri"],"items":{"type":"string","description":"What days the line item should run. Valid values: mon, tue, wed, thu, fri, sat, sun","example":"[\"mon\",\"tue\",\"wed\",\"thu\",\"fri\"]","enum":["mon","tue","wed","thu","fri","sat","sun"]},"enum":["mon","tue","wed","thu","fri","sat","sun"]},"hours":{"type":"array","description":"What hours the line item should run. Time ranges in HH:00-HH:00 format (24-hour, on the hour only)","example":["06:00-10:00","17:00-23:00"],"items":{"type":"string","description":"What hours the line item should run. Time ranges in HH:00-HH:00 format (24-hour, on the hour only)","example":"[\"06:00-10:00\",\"17:00-23:00\"]"}}},"description":"The schedule for day parting"},"LineItemFlightMaxDailySpendOverrideRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"When TRUE, the user must enter what the override should be. When FALSE the default value of 2x will be used","example":true},"type":{"type":"string","description":"Type of overriding field.","example":"amount","enum":["amount","multiplier"]},"value":{"minimum":0.01,"exclusiveMinimum":false,"type":"number","description":"The value of the amount or multiplier for the max daily spend override","format":"double","example":5.45}},"description":"This optional field is a safety check that limits daily spend, regardless of current budget or pacing. Default is 2x the even pacing of your flight."},"LineItemRequest":{"required":["campaignId","costModel","flights","inventoryType","name","timeZone"],"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string","description":"Line item display name","example":"lineItem_12345"},"campaignId":{"type":"integer","description":"The campaign id where you want to add the line item","format":"int64","example":1001},"costModel":{"type":"string","description":"Pricing model. CPC is allowed only for Native & Search inventory type. 'Fixed CPM' is only available for managed service accounts.","example":"CPM","enum":["CPM","Fixed CPM","CPC"]},"description":{"maxLength":1000,"minLength":1,"type":"string","description":"Line item description","example":"This is a sample line item description."},"inventoryType":{"type":"string","description":"Ad inventory type","example":"Display","enum":["Display","Video","Audio","Native","Search","DOOH","NativeVideo"]},"budgetDistribution":{"type":"string","description":"How budgets should be spent across tactics. Default is Dollars.","example":"Dollars","enum":["Dollars","Percent","Priority"]},"customFieldSettings":{"type":"array","description":"Custom field configurations for the line item","items":{"$ref":"#/components/schemas/CustomFieldSettingRequest"}},"flights":{"type":"array","description":"Break down campaign budgets into discrete time periods","items":{"$ref":"#/components/schemas/FlightRequest"}},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapRequest"},"dayParting":{"$ref":"#/components/schemas/LineItemDayPartingRequest"},"managementFee":{"$ref":"#/components/schemas/ManagementFeeRequest"},"timeZone":{"type":"string","description":"The timezone that the line item should run in","example":"Eastern Time","enum":["Eastern Time","Central Time","Mountain Time","Pacific Time","Greenwich Mean Time","Central European Time","India Standard Time","China Standard Time","Australian Eastern Time","Eastern European Time","Moscow Time","Samara Time","Maldives Time","Omsk Time","Christmas Island Time","Japan Standard Time","Sakhalin Time","New Zealand Time","Azores Time","Argentina Time","Atlantic Time (Canada)","Alaska Time (USA)","Hawaii Time"]}}},"ManagementFeeRequest":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of management fee at the line item level","example":"Percentage","enum":["Percentage","CPM","PercentageAndCPM","FixedCPM"]},"percentage":{"maximum":99.99,"exclusiveMaximum":false,"minimum":0.01,"exclusiveMinimum":false,"type":"number","description":"Required in management fee types of Percentage or PercentageAndCPM","format":"double","example":10.25},"cpm":{"maximum":999999999999.99,"exclusiveMaximum":false,"minimum":0.01,"exclusiveMinimum":false,"type":"number","description":"Required in management fee types of CPM , PercentageAndCPM , FixedCPM","format":"double","example":266.5}},"description":"The amount an agency charges an advertiser for campaign setup. Cannot be used with CPC costModel line items."},"CustomFieldSettingResponseData":{"type":"object","properties":{"fieldId":{"type":"integer","description":"Id of the custom field setting","format":"int64","example":123},"fieldName":{"type":"string","example":"Custom Field Name"},"fieldValue":{"type":"string","example":"custom field value"}},"description":"Custom field settings for the campaign"},"DayPartingResponseData":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If day parting isn’t enabled, the line item will run the full day","example":true},"schedule":{"type":"array","description":"The schedule for day parting","items":{"$ref":"#/components/schemas/DayPartingScheduleResponseData"}}},"description":"Dayparting settings for the line item."},"DayPartingScheduleResponseData":{"type":"object","properties":{"days":{"type":"array","description":"What days the line item will run. Valid values: mon, tue, wed, thu, fri, sat, sun","example":["mon","tue","wed","thu","fri"],"items":{"type":"string","description":"What days the line item will run. Valid values: mon, tue, wed, thu, fri, sat, sun","example":"[\"mon\",\"tue\",\"wed\",\"thu\",\"fri\"]","enum":["mon","tue","wed","thu","fri","sat","sun"]},"enum":["mon","tue","wed","thu","fri","sat","sun"]},"hours":{"type":"array","description":"What hours the line item will run. Time ranges in HH:00-HH:00 format (24-hour, on the hour only)","example":["06:00-10:00","17:00-23:00"],"items":{"type":"string","description":"What hours the line item will run. Time ranges in HH:00-HH:00 format (24-hour, on the hour only)","example":"[\"06:00-10:00\",\"17:00-23:00\"]"}}},"description":"The schedule for day parting"},"FlightMaxDailySpendOverrideResponseData":{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"type":{"type":"string","description":"Type of overriding field.","example":"amount","enum":["amount","multiplier"]},"value":{"type":"number","description":"The value of the amount or multiplier for the max daily spend override","format":"double","example":5.45}},"description":"Limits your Daily Spend, regardless of current budget or pacing."},"FlightResponseData":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":43215},"budget":{"type":"number","description":"Flight Budget amount","format":"double","example":50},"startDate":{"type":"string","description":"Flight start date. Format: MM-dd-yyyy HH:mm:ss","example":"11-01-2025 00:00:00"},"endDate":{"type":"string","description":"Flight end date. Format: MM-dd-yyyy HH:mm:ss","example":"11-30-2025 22:59:59"},"pacingMode":{"type":"string","description":"Budget pacing strategy","example":"EVEN","enum":["EVEN","ASAP","AHEAD"]},"paceAheadPercent":{"type":"number","description":"Pacing percentage modifier","format":"double","example":99},"totalImpressionCap":{"type":"integer","description":"Total Impressions that can serve for a given flight","format":"int32","example":5000},"dailyImpressionCap":{"type":"integer","description":"Total impressions that can serve per day on a given flight.","format":"int32","example":1000},"maxDailySpendOverride":{"$ref":"#/components/schemas/FlightMaxDailySpendOverrideResponseData"}},"description":"List of flights associated with the line item"},"FrequencyCapResponseData":{"type":"object","properties":{"applyFrequencyCap":{"type":"boolean","description":"If frequency capping is enabled","example":true},"times":{"type":"integer","description":"Impression limit","format":"int32","example":9},"period":{"type":"string","description":"Time period.","example":"day","enum":["day","hour(s)","week","month"]},"hoursValue":{"type":"integer","description":"Custom hour period. Available if period=hour(s).","format":"int32","example":1},"crossDevice":{"type":"string","description":"Cross-device tracking.","example":"Per Device","enum":["Per Device","Per Person","Per Household"]},"untrackable":{"type":"boolean","description":"Include untrackable users","example":true},"ipUntrackable":{"type":"boolean","description":"Include IP-untrackable users","example":false}},"description":"Frequency cap settings for the campaign"},"LineItemChanges":{"type":"object","properties":{"updatedFields":{"type":"array","description":"List of fields that were updated during the replace operation","example":["name","inventoryType"],"items":{"type":"string","description":"List of fields that were updated during the replace operation","example":"[\"name\",\"inventoryType\"]"}},"flightsModified":{"type":"integer","description":"Number of flights that were modified in the lineitem","format":"int32","example":2},"flightsAdded":{"type":"integer","description":"Number of flights that were added to the lineitem","format":"int32","example":2},"flightsRemoved":{"type":"integer","description":"Number of flights that were removed from the lineitem","format":"int32","example":2},"customFieldsAdded":{"type":"integer","description":"Number of customfields that were added to the lineitem","format":"int32","example":5},"customFieldsModified":{"type":"integer","description":"Number of customfields that were modified in the lineitem","format":"int32","example":5},"customFieldsRemoved":{"type":"integer","description":"Number of customfields that were removed from the lineitem","format":"int32","example":5}},"description":"Details of changes made during the replace operation"},"LineItemData":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":12345},"name":{"type":"string","example":"lineItem_12345"},"campaignId":{"type":"integer","description":"The campaign id where the line item belongs to","format":"int64","example":1001},"costModel":{"type":"string","description":"Pricing model","example":"CPM"},"cpmPrice":{"type":"number","description":"CPM Price incase of Fixed CPM cost model.","format":"double","example":25.9},"description":{"type":"string","description":"Line item description","example":"This is a sample line item description."},"inventoryType":{"type":"string","description":"Ad inventory type","example":"Display","enum":["Display","Video","Audio","Native","Search","DOOH","NativeVideo"]},"budgetDistribution":{"type":"string","description":"How should budgets are spent across tactics","example":"Dollars","enum":["Priority","Dollars","Percent"]},"timeZone":{"type":"string","description":"The timezone that the line item is running","example":"Eastern Time","enum":["Eastern Time","Central Time","Mountain Time","Pacific Time","Greenwich Mean Time","Central European Time","India Standard Time","China Standard Time","Australian Eastern Time","Eastern European Time","Moscow Time","Samara Time","Maldives Time","Omsk Time","Christmas Island Time","Japan Standard Time","Sakhalin Time","New Zealand Time","Azores Time","Argentina Time","Atlantic Time (Canada)","Alaska Time (USA)","Hawaii Time"]},"customFieldSettings":{"type":"array","description":"Custom field settings associated with the line item","items":{"$ref":"#/components/schemas/CustomFieldSettingResponseData"}},"flights":{"type":"array","description":"List of flights associated with the line item","items":{"$ref":"#/components/schemas/FlightResponseData"}},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapResponseData"},"dayParting":{"$ref":"#/components/schemas/DayPartingResponseData"},"managementFee":{"$ref":"#/components/schemas/ManagementFeeResponseData"}},"description":"LineItem data"},"ManagementFeeResponseData":{"type":"object","properties":{"type":{"type":"string","description":"The type of management fee at the line item level","example":"Percentage","enum":["Percentage","CPM","PercentageAndCPM","FixedCPM"]},"percentage":{"type":"number","description":"Required in management fee types of Percentage or PercentageAndCPM","format":"double","example":10.25},"cpm":{"type":"number","description":"Required in management fee types of CPM , PercentageAndCPM , FixedCPM","format":"double","example":266.5}},"description":"Management fee settings for the campaign"},"ReplaceLineItemMetaDataResponse":{"type":"object","properties":{"changes":{"$ref":"#/components/schemas/LineItemChanges"}},"description":"Additional metadata related to the replaced line item"},"ReplaceLineItemResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/LineItemData"},"meta":{"$ref":"#/components/schemas/ReplaceLineItemMetaDataResponse"}}},"NPIGroupRequest":{"required":["advertisers","applications","name","npis"],"type":"object","properties":{"name":{"maxLength":100,"minLength":1,"type":"string","example":"Endocrinologist_2022_1"},"advertisers":{"type":"array","example":["Demo"],"items":{"type":"string","example":"[\"Demo\"]"}},"npis":{"uniqueItems":true,"type":"array","example":["3137933127","3134730121"],"items":{"type":"string","example":"[\"3137933127\",\"3134730121\"]"}},"applications":{"maxItems":3,"minItems":1,"uniqueItems":true,"type":"array","example":["LIFE"],"items":{"type":"string","example":"[\"LIFE\"]","enum":["LIFE","SIGNAL","SOCIAL_INTEGRATIONS"]},"enum":["LIFE","SIGNAL","SOCIAL_INTEGRATIONS"]}}},"NPIGroupWithRefsData":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":4210},"name":{"type":"string","example":"NPI_4210"},"advertisers":{"type":"array","example":["Demo"],"items":{"type":"string","example":"[\"Demo\"]"}},"applications":{"type":"array","example":["life","signal"],"items":{"type":"string","example":"[\"life\",\"signal\"]"}},"listType":{"type":"string","description":"NPI List type","example":"attributes","enum":["static","attributes","smartlist","studio"]},"npis":{"uniqueItems":true,"type":"array","example":["1234567891","1234567892","1234567893","1234567894","1234567895","123 4567896","1234567897"],"items":{"type":"string","example":"[\"1234567891\",\"1234567892\",\"1234567893\",\"1234567894\",\"1234567895\",\"123 4567896\",\"1234567897\"]"}}},"description":"NPI Group with NPI data"},"NPIGroupWithRefsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/NPIGroupWithRefsData"}}},"NPIGroupAttributeRequest":{"required":["advertisers","applications","attributeValues","attributes","name","npiColumnIndex"],"type":"object","properties":{"name":{"maxLength":100,"minLength":1,"type":"string","description":"NPI list name (upon creation)","example":"NPI_with_Attr"},"advertisers":{"type":"array","example":["Demo"],"items":{"type":"string","example":"[\"Demo\"]"}},"attributes":{"type":"array","description":"Column headers","example":["NPI_ID","Active","CampaignName"],"items":{"type":"string","description":"Column headers","example":"[\"NPI_ID\",\"Active\",\"CampaignName\"]"}},"attributeValues":{"type":"array","description":"value for corresponding attribute header per NPI","example":[["1639137706","yes","NPI Targeted Banners"]],"items":{"type":"array","description":"value for corresponding attribute header per NPI","example":[["1639137706","yes","NPI Targeted Banners"]],"items":{"type":"string","description":"value for corresponding attribute header per NPI","example":"[[\"1639137706\",\"yes\",\"NPI Targeted Banners\"]]"}}},"npiColumnIndex":{"minimum":0,"type":"integer","description":"which column contains NPIs (Starts with first column = 0)","format":"int32","example":0},"applications":{"uniqueItems":true,"type":"array","example":["LIFE"],"items":{"type":"string","example":"[\"LIFE\"]","enum":["LIFE","SIGNAL","SOCIAL_INTEGRATIONS"]},"enum":["LIFE","SIGNAL","SOCIAL_INTEGRATIONS"]}}},"NPIGroupAttributeResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/NPIGroupAttributeResponseData"}}},"NPIGroupAttributeResponseData":{"type":"object","properties":{"npiGroupId":{"type":"integer","description":"NPI Group ID","format":"int64","example":4210},"attributes":{"type":"array","description":"Column headers","example":["NPI_ID","Active","CampaignName"],"items":{"type":"string","description":"Column headers","example":"[\"NPI_ID\",\"Active\",\"CampaignName\"]"}},"attributeValues":{"type":"array","description":"value for corresponding attribute header per NPI","example":[["1639137706","yes","NPI Targeted Banners"]],"items":{"type":"array","description":"value for corresponding attribute header per NPI","example":[["1639137706","yes","NPI Targeted Banners"]],"items":{"type":"string","description":"value for corresponding attribute header per NPI","example":"[[\"1639137706\",\"yes\",\"NPI Targeted Banners\"]]"}}},"name":{"type":"string","description":"NPI list name (upon creation)","example":"NPI_with_Attr"},"applications":{"type":"array","example":["life","signal"],"items":{"type":"string","example":"[\"life\",\"signal\"]"}},"advertisers":{"type":"array","example":["Demo"],"items":{"type":"string","example":"[\"Demo\"]"}}},"description":"NPI Group Attribute data"},"CampaignImportCollectionRequest":{"required":["campaign"],"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/CampaignImportRequest"}}},"CampaignImportFrequencyCapRequest":{"required":["applyFrequencyCap"],"type":"object","properties":{"applyFrequencyCap":{"type":"string","example":"true"},"times":{"pattern":"^[0-9]+$","type":"string","description":"Must be a number","example":"9"},"period":{"type":"string","example":"day","enum":["day","hour(s)","week","month"]},"hoursValue":{"pattern":"^[0-9]+$","type":"string","description":"Must be a number","example":"1"},"crossDevice":{"type":"string","example":"Per Device","enum":["Per Device","Per Person","Per Household"]}},"description":"Frequency cap settings for the campaign. If not set, the default frequency cap configured for the account will be used."},"CampaignImportRequest":{"required":["account","advertiserId","budgetCap","lineItems","name"],"type":"object","properties":{"name":{"type":"string","description":"Name must be unique","example":"Campaign REST API SAMPLE"},"description":{"maxLength":500,"minLength":0,"type":"string","description":"Campaign description","example":"DESCRIPTION"},"advertiserId":{"type":"integer","description":"This is the ID of the advertiser you want your campaign to run under","format":"int64","example":123456},"budgetCap":{"pattern":"\\d+(\\.\\d+)?","type":"string","description":"Budget cap for the campaign","example":"10000.0"},"account":{"pattern":"^[0-9]+$","type":"string","description":"This is the same ID used in authorizing into the API","example":"222333"},"drugName":{"type":"string","description":"If not null, must be a valid drug from PulsePoint’s List of Drugs","example":"Tylenol PM","default":"the default drug configured for the advertiser"},"basketDrugNames":{"type":"array","description":"If not null, must be a valid drug from PulsePoint’s List of Drugs","example":["Tylenol PM"],"items":{"type":"string","description":"If not null, must be a valid drug from PulsePoint’s List of Drugs","example":"[\"Tylenol PM\"]"}},"customFieldSetting":{"type":"array","description":"Add meta data to your campaign to see in reporting","items":{"$ref":"#/components/schemas/CustomFieldSettingRequest"}},"lineItems":{"maxItems":2147483647,"minItems":1,"type":"array","description":"List of line items for the campaign","items":{"$ref":"#/components/schemas/LineItemImportRequest"}},"frequencyCap":{"$ref":"#/components/schemas/CampaignImportFrequencyCapRequest"}},"description":"Create Campaign and Line Item"},"LineItemFlightImportRequest":{"required":["budget","endDate","pacingMode","startDate"],"type":"object","properties":{"budget":{"pattern":"\\d+(\\.\\d+)?","type":"string","example":"50"},"startDate":{"type":"string","example":"2025-04-01 00:00"},"endDate":{"type":"string","example":"2025-04-30 23:59"},"pacingMode":{"type":"string","example":"Even","enum":["EVEN","ASAP","AHEAD"]},"pacingModePercentage":{"pattern":"\\d+(\\.\\d+)?","type":"string","description":"Applicable only if pacingMode=”Ahead\" If you enter “10” it will interpreted as 10%","example":"12.1"}},"description":"List of flights for the line item"},"LineItemImportFrequencyCapRequest":{"required":["applyFrequencyCap"],"type":"object","properties":{"applyFrequencyCap":{"type":"string","example":"true"},"times":{"pattern":"^[0-9]+$","type":"string","description":"Must be a number","example":"9"},"period":{"type":"string","example":"day","enum":["day","hour(s)","week","month"]},"hoursValue":{"pattern":"^[0-9]+$","type":"string","description":"Must be a number","example":"1"},"crossDevice":{"type":"string","example":"Per Device","enum":["Per Device","Per Person","Per Household"]}},"description":"Frequency cap settings for the line item. If not set, the default frequency cap configured for the account will be used."},"LineItemImportRequest":{"required":["costModel","flights","inventoryType","name"],"type":"object","properties":{"name":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Must be unique within the same campaign","example":"lineitem"},"costModel":{"type":"string","example":"CPM","enum":["CPM","Fixed CPM"]},"cpmPrice":{"type":"string","description":"Cost per thousand impressions. Required for FixedCPM campaign cost method","example":"5.0"},"description":{"maxLength":500,"minLength":0,"type":"string","example":"DESCRIPTION"},"inventoryType":{"type":"string","example":"Display","enum":["Display","Video","Audio","Native Display","Search Extension","DOOH","Native Video"]},"customFieldSetting":{"type":"array","description":"Add meta data to your campaign to see in reporting","items":{"$ref":"#/components/schemas/CustomFieldSettingRequest"}},"flights":{"maxItems":2147483647,"minItems":1,"type":"array","description":"List of flights for the line item","items":{"$ref":"#/components/schemas/LineItemFlightImportRequest"}},"frequencyCap":{"$ref":"#/components/schemas/LineItemImportFrequencyCapRequest"}},"description":"List of line items for the campaign"},"CreateCampaignData":{"type":"object","properties":{"campaignId":{"type":"string","example":"123456"},"campaignName":{"type":"string","example":"Campaign REST API Sample"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItemResponse"}}},"description":"Campaign data"},"CreateCampaignResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/CreateCampaignData"}}},"LineItemResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/LineItemData"}}},"AppListRequest":{"required":["include","listId"],"type":"object","properties":{"listId":{"type":"integer","description":"App List ID to be targeted.","format":"int64","example":67890},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified app list id.","example":true,"enum":[true,false]}},"description":"List of App Lists to be targeted."},"BehavioralSegmentRequest":{"required":["include","providerId","segmentId"],"type":"object","properties":{"segmentId":{"type":"integer","description":"The ID of the behavioral segment","format":"int64"},"providerId":{"type":"integer","description":"The data provider of the behavioral segment","format":"int64"},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified segment.","example":true,"enum":[true,false]}},"description":"List of behavioral segments"},"BehavioralSegmentsTargetingRequest":{"required":["segments"],"type":"object","properties":{"crossDevice":{"type":"string","description":"Cross-device tracking. Default is 'device'. ","example":"device","enum":["device","person","household","household_ip"]},"segments":{"type":"array","description":"List of behavioral segments","items":{"$ref":"#/components/schemas/BehavioralSegmentRequest"}}},"description":"Behavioral Segments targeting for the tactic"},"BudgetDistributionRequest":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","description":"Must be the same as line item budget distribution type","example":"Dollars","enum":["Dollars","Percent","Priority"]},"value":{"type":"number","description":"The allocation for this tactic within the line item flight.","format":"double","example":75}},"description":"Set at the Line Item level. Use this object to define the values you want per tactic."},"CreativeAssignmentsRequest":{"required":["creativeId"],"type":"object","properties":{"creativeId":{"type":"integer","description":"The ID of the creative to be assigned to the tactic.","format":"int64","example":12345},"weight":{"type":"integer","description":"Weight should be used if you want one creative of the same adsize within a tactic to get more impressions than another creative.","format":"int32","example":10},"startDate":{"type":"string","description":"A scheduled date for a specific creative to start being used within a tactic.","example":"2025-12-30 23:59:59"},"endDate":{"type":"string","description":"A scheduled date for a specific creative to stop being used within a tactic","example":"2025-12-31 23:59:59"}},"description":"Creative assignments for the tactic. A tactic will not serve without at least one creative assigned."},"DevicesTargetingRequest":{"required":["deviceTypes","include"],"type":"object","properties":{"deviceTypes":{"uniqueItems":true,"type":"array","description":"List of device types to be targeted or excluded.","example":["mobile","desktop"],"items":{"type":"string","description":"List of device types to be targeted or excluded.","example":"[\"mobile\",\"desktop\"]","enum":["desktop","mobile","phone","tablet","connected_tv","connected_device","set_top_box","ooh_device"]},"enum":["desktop","mobile","phone","tablet","connected_tv","connected_device","set_top_box","ooh_device"]},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified devices.","example":true,"enum":[true,false]}},"description":"Devices targeting for the tactic"},"DomainAppsTargetingRequest":{"type":"object","properties":{"domainLists":{"type":"array","description":"List of Domain Lists to be targeted.","items":{"$ref":"#/components/schemas/DomainListRequest"}},"domains":{"type":"array","description":"List of Individual Domains to be targeted.","items":{"$ref":"#/components/schemas/IndividualDomainRequest"}},"appLists":{"type":"array","description":"List of App Lists to be targeted.","items":{"$ref":"#/components/schemas/AppListRequest"}},"apps":{"type":"array","description":"List of Individual Apps to be targeted.","items":{"$ref":"#/components/schemas/IndividualAppRequest"}}},"description":"Domains and Apps targeting for the tactic"},"DomainListRequest":{"required":["include","listId"],"type":"object","properties":{"listId":{"type":"integer","description":"Domain List ID to be targeted.","format":"int64","example":12345},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified domain list.","example":true,"enum":[true,false]}},"description":"List of Domain Lists to be targeted."},"GeoTargetParent":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","description":"Type of parent geo target.","example":"country","enum":["country","state"]},"value":{"type":"string","description":"Value of parent geo target. For country use ISO (e.g., 'usa', 'gbr'), for state use ISO (e.g., 'CA', 'NY').","example":"US"},"parent":{"$ref":"#/components/schemas/GeoTargetParent"}},"description":"Parent geo target. Required for 'state', 'city', and 'metro' types. For 'state' and 'metro', parent type must be 'country'. For 'city', parent type must be 'state'."},"GeoTargetsRequest":{"required":["include","type","values"],"type":"object","properties":{"type":{"type":"string","description":"Type of geo target to target or block.","example":"state","enum":["country","state","city","metro"]},"values":{"uniqueItems":true,"type":"array","description":"List of geo target values. For country use ISO (e.g., 'gbr', 'usa'), for state use ISO (e.g., 'NY', 'CA'), for city use name (e.g., 'Los Angeles', 'san francisco'), for metro use name (e.g., 'philadelphia').","example":["NY","CA"],"items":{"type":"string","description":"List of geo target values. For country use ISO (e.g., 'gbr', 'usa'), for state use ISO (e.g., 'NY', 'CA'), for city use name (e.g., 'Los Angeles', 'san francisco'), for metro use name (e.g., 'philadelphia').","example":"[\"NY\",\"CA\"]"}},"parent":{"$ref":"#/components/schemas/GeoTargetParent"},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified geo target values.","example":true,"enum":[true,false]}},"description":"Geo Targets targeting for the tactic"},"HcpByPractitionerTargetingRequest":{"required":["segments"],"type":"object","properties":{"crossDevice":{"type":"string","description":"Cross-device tracking. Default is 'device'.","example":"device","enum":["device","person","home_ip","practice_ip"]},"npiReporting":{"type":"boolean","description":"If you choose to enable reporting you will be able to access NPI as a dimension in Life Reporting. Note that you will incur a fee.","example":true},"segments":{"type":"array","items":{"$ref":"#/components/schemas/PixelSegmentRequest"}}},"description":"HCP by Practitioner Targeting for the tactic"},"HealthPopulationSegmentRequest":{"required":["include","meshCode","segmentType"],"type":"object","properties":{"meshCode":{"type":"string","description":"MeshCode of health population segment.","example":"E03.091.080"},"segmentType":{"type":"string","description":"Type of health population segment.","example":"condition","enum":["condition","treatment"]},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified segment.","example":true,"enum":[true,false]}},"description":"List of health population segments"},"HealthPopulationsTargetingRequest":{"required":["operator","segments"],"type":"object","properties":{"crossDevice":{"type":"string","description":"Cross-device tracking. Default is 'device'. ","example":"device","enum":["device","person","household","household_ip"]},"operator":{"type":"string","description":"Whether the user needs to be in every selected population (AND) or only one of the selected populations (OR)","example":"AND","enum":["AND","OR"]},"historicalPeriod":{"type":"string","description":"The historical period in days for health populations targeting. Default is 90plus .","example":"15","enum":["3","15","90plus"]},"segments":{"type":"array","description":"List of health population segments","items":{"$ref":"#/components/schemas/HealthPopulationSegmentRequest"}}},"description":"Health Populations targeting for the tactic"},"IABNewCategoryRequest":{"required":["categoryId","include"],"type":"object","properties":{"categoryId":{"type":"integer","description":"IAB Category ID.","format":"int64","example":32},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified category.","example":true,"enum":[true,false]}},"description":"List of IAB New Categories to target"},"IABNewCategoryTargetingRequest":{"required":["categories"],"type":"object","properties":{"categories":{"type":"array","description":"List of IAB New Categories to target","items":{"$ref":"#/components/schemas/IABNewCategoryRequest"}}},"description":"IAB Categories targeting for the tactic"},"IndividualAppRequest":{"required":["appName","include"],"type":"object","properties":{"appName":{"type":"string","description":"Individual App bundle to be targeted.","example":"com.example.app1"},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified app bundles.","example":true,"enum":[true,false]}},"description":"List of Individual Apps to be targeted."},"IndividualDomainRequest":{"required":["domainName","include"],"type":"object","properties":{"domainName":{"type":"string","description":"List of individual domain name to be targeted.","example":"example.com"},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified domain.","example":true,"enum":[true,false]}},"description":"List of Individual Domains to be targeted."},"InventorySourcesTargetingRequest":{"required":["exchanges","include"],"type":"object","properties":{"exchanges":{"uniqueItems":true,"type":"array","description":"List of exchanges to include or exclude.","example":["exchange_1","exchange_2"],"items":{"type":"string","description":"List of exchanges to include or exclude.","example":"[\"exchange_1\",\"exchange_2\"]"}},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified exchanges.","example":true,"enum":[true,false]}},"description":"Inventory Sources targeting for the tactic"},"InventoryTypesTargetingRequest":{"required":["include","types"],"type":"object","properties":{"types":{"uniqueItems":true,"type":"array","description":"Type of inventory.","example":"app","items":{"type":"string","description":"Type of inventory.","example":"app","enum":["app","email","site"]},"enum":["app","email","site"]},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified inventory type.","example":true,"enum":[true,false]}},"description":"Inventory Types targeting for the tactic"},"MaxSpendPerTacticRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether the max spend per tactic is enabled.","example":true},"amount":{"minimum":0.01,"exclusiveMinimum":false,"type":"number","description":"The maximum spend amount for the tactic.","format":"double","example":5000},"period":{"type":"string","description":"The period over which the max spend is calculated.","example":"lifetime"}},"description":"Maximum spend of the tactic"},"MediaOptimizationRequest":{"type":"object","properties":{"type":{"type":"string","description":"The type of media optimization to be applied for the tactic.","example":"CTR","default":"CPM","enum":["CPM","FLAT","CPC","CTR","CPA","Tactic_Reach","LineItem_Reach","Campaign_Reach","Viewability"]},"goal":{"type":"number","description":"The goal value for the specified media optimization type. Required for 'Viewability', 'CTR', 'CPA' optimization types.","format":"double","example":2.5},"conversionPixelId":{"type":"integer","description":"The ID of the conversion pixel associated with CPA media optimization. Required when media optimization type is 'CPA'.","format":"int64","example":382920}},"description":"Media optimization settings for the tactic."},"NPIListTargetingRequest":{"required":["include","listId"],"type":"object","properties":{"listId":{"type":"integer","description":"The ID of the NPI list.","format":"int64","example":12345},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified NPI list.","example":true,"enum":[true,false]}},"description":"NPI Lists targeting for the tactic"},"NPINumbersTargetingRequest":{"required":["include","numbers"],"type":"object","properties":{"numbers":{"uniqueItems":true,"type":"array","example":["3137933127","3134730121"],"items":{"type":"string","example":"[\"3137933127\",\"3134730121\"]"}},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified NPI list.","example":true,"enum":[true,false]}},"description":"NPI Numbers targeting for the tactic"},"NPITargetingRequest":{"type":"object","properties":{"crossDevice":{"type":"string","description":"Cross-device tracking. Default is 'device'. ","example":"device","enum":["device","person","home_ip","practice_ip"]},"npiReporting":{"type":"boolean","description":"If you choose to enable reporting you will be able to access NPI as a dimension in Life Reporting. Note that you will incur a fee.","example":true},"lists":{"type":"array","description":"NPI Lists targeting for the tactic","items":{"$ref":"#/components/schemas/NPIListTargetingRequest"}},"npiNumbers":{"$ref":"#/components/schemas/NPINumbersTargetingRequest"}},"description":"NPI Targeting for the tactic"},"PixelRequest":{"required":["include","pixelId"],"type":"object","properties":{"pixelId":{"type":"integer","description":"The ID of the retargeting pixel.","format":"int64","example":12345},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified pixel.","example":true,"enum":[true,false]}},"description":"List of retargeting pixels"},"PixelSegmentRequest":{"required":["include","segmentId","segmentType"],"type":"object","properties":{"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified segment.","example":true,"enum":[true,false]},"segmentId":{"type":"integer","description":"The ID of the practitioner or specialty that you want to include or exclude","format":"int64","example":456},"segmentType":{"type":"string","description":"type of the segment","example":"practitioner","enum":["practitioner","specialty"]}}},"RetargetingPixelRequest":{"required":["pixels"],"type":"object","properties":{"crossDevice":{"type":"string","description":"Cross-device tracking. Default is 'device'. ","example":"device","enum":["device","person","household","household_ip"]},"recency":{"type":"string","description":"Recency in days for the retargeting pixels. Default is 90plus.","example":"90","enum":["1","7","15","30","60","90","90plus"]},"pixels":{"type":"array","description":"List of retargeting pixels","items":{"$ref":"#/components/schemas/PixelRequest"}}},"description":"Reach retargeting audiences"},"TacticManagementFeeRequest":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of management fee at the tactic level","example":"Percentage","enum":["Percentage","CPM","PercentageAndCPM"]},"percentage":{"maximum":99.99,"exclusiveMaximum":false,"minimum":0.01,"exclusiveMinimum":false,"type":"number","description":"Required in management fee types of Percentage or PercentageAndCPM","format":"double","example":10.25},"cpm":{"maximum":999999999999.99,"exclusiveMaximum":false,"minimum":0.01,"exclusiveMinimum":false,"type":"number","description":"Required in management fee types of CPM , PercentageAndCPM ","format":"double","example":266.5}},"description":"Additional fee taken by advertiser."},"TacticRequest":{"required":["lineItemId","name"],"type":"object","properties":{"lineItemId":{"type":"integer","description":"The ID of the line item associated with this tactic.","format":"int64","example":12345},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the tactic.","example":"Test Tactic"},"description":{"maxLength":80,"minLength":0,"type":"string","description":"The description of the tactic.","example":"Testing Remarketing."},"enabled":{"type":"boolean","description":"Whether you want the tactic to be enabled or disabled upon creation","example":true},"baseBidPrice":{"maximum":999999999.999,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":true,"type":"number","description":"The base bid price for the tactic. Must be less than or equal to Max Bid Price.","example":10,"default":1},"maxBidPrice":{"maximum":999999999.999,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":true,"type":"number","description":"The maximum bid price for the tactic. Must be greater than or equal to Base Bid Price.","example":25,"default":50},"customFieldSettings":{"type":"array","description":"Custom field configurations for the tactic. If account level custom fields are mandatory at the tactic level, this will be mandatory for those fields.","items":{"$ref":"#/components/schemas/CustomFieldSettingRequest"}},"budgetDistribution":{"$ref":"#/components/schemas/BudgetDistributionRequest"},"maxSpendPerTactic":{"$ref":"#/components/schemas/MaxSpendPerTacticRequest"},"managementFee":{"$ref":"#/components/schemas/TacticManagementFeeRequest"},"mediaOptimization":{"$ref":"#/components/schemas/MediaOptimizationRequest"},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapRequest"},"creativeAssignments":{"type":"array","description":"Creative assignments for the tactic. A tactic will not serve without at least one creative assigned.","items":{"$ref":"#/components/schemas/CreativeAssignmentsRequest"}},"targeting":{"$ref":"#/components/schemas/TargetingRequest"}}},"TargetingRequest":{"type":"object","properties":{"hcpByPractitioner":{"$ref":"#/components/schemas/HcpByPractitionerTargetingRequest"},"npiTargeting":{"$ref":"#/components/schemas/NPITargetingRequest"},"retargetingPixels":{"$ref":"#/components/schemas/RetargetingPixelRequest"},"behavioralSegments":{"$ref":"#/components/schemas/BehavioralSegmentsTargetingRequest"},"healthPopulations":{"$ref":"#/components/schemas/HealthPopulationsTargetingRequest"},"iabNewCategories":{"$ref":"#/components/schemas/IABNewCategoryTargetingRequest"},"geoTargets":{"type":"array","description":"Geo Targets targeting for the tactic","items":{"$ref":"#/components/schemas/GeoTargetsRequest"}},"devices":{"$ref":"#/components/schemas/DevicesTargetingRequest"},"domainsApps":{"$ref":"#/components/schemas/DomainAppsTargetingRequest"},"inventorySources":{"$ref":"#/components/schemas/InventorySourcesTargetingRequest"},"inventoryTypes":{"$ref":"#/components/schemas/InventoryTypesTargetingRequest"},"viewability":{"$ref":"#/components/schemas/ViewabilityTargetingRequest"}},"description":"Targeting settings for the tactic."},"ViewabilityTargetingRequest":{"required":["minViewabilityRate"],"type":"object","properties":{"minViewabilityRate":{"maximum":80,"minimum":1,"type":"integer","description":"Minimum viewability rate percentage for the targeting","format":"int32","example":10},"provider":{"type":"string","description":"Viewability provider for the targeting. Currently, only 'DV' is supported","example":"DV","enum":["DV"]}},"description":"Viewability targeting for the tactic"},"AppListResponse":{"type":"object","properties":{"listId":{"type":"integer","description":"App List ID.","format":"int64","example":67890},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified app list.","example":true}},"description":"List of App Lists."},"AuthenticBrandSuitabilityTargetingResponse":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether Authentic Brand Suitability targeting is enabled or disabled.","example":true},"dv_segment_id":{"type":"integer","description":"DoubleVerify Authentic Brand Suitability ID for Authentic Brand Suitability targeting.","format":"int64","example":51000000}},"description":"Authentic Brand Suitability targeting for the tactic"},"BehavioralSegmentResponse":{"type":"object","properties":{"segmentId":{"type":"integer","description":"The ID of the behavioral segment","format":"int64","example":123},"providerId":{"type":"integer","description":"The data provider ID of the behavioral segment","format":"int64","example":456},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified segment.","example":true}},"description":"List of behavioral segments"},"BehavioralSegmentsTargetingResponse":{"type":"object","properties":{"crossDevice":{"type":"string","description":"Cross-device tracking.","example":"device"},"segments":{"type":"array","description":"List of behavioral segments","items":{"$ref":"#/components/schemas/BehavioralSegmentResponse"}}},"description":"Behavioral Segments targeting for the tactic"},"BrandSafetySuitabilityTargetingResponse":{"type":"object","properties":{"exclude":{"type":"array","description":"Ids of the Brand Safety Suitability segments.","example":[3,50],"items":{"type":"integer","description":"Ids of the Brand Safety Suitability segments.","format":"int64"}}},"description":"Brand Safety targeting for the tactic"},"BudgetDistributionResponse":{"type":"object","properties":{"type":{"type":"string","description":"Must be the same as line item budget distribution type","example":"Dollars","enum":["Dollars","Percent","Priority"]},"value":{"type":"number","description":"The allocation for this tactic within the line item flight.","format":"double","example":75}},"description":"Set at the Line Item level. Use this object to define the values you want per tactic."},"CreativeAssignmentsResponse":{"type":"object","properties":{"creativeId":{"type":"integer","description":"The ID of the creative assigned to the tactic.","format":"int64","example":12345},"creativeName":{"type":"string","description":"The name of the creative assigned to the tactic.","example":"Test Creative"},"creativeStatus":{"type":"string","description":"The status of the creative assigned to the tactic.","example":"PendingApproval","enum":["PendingApproval","Approved","Denied"]},"height":{"type":"integer","description":"The height of the ad size of the creative assigned to the tactic.","format":"int32","example":600},"width":{"type":"integer","description":"The width of the ad size of the creative assigned to the tactic.","format":"int32","example":100},"weight":{"type":"integer","description":"Weight should be used if you want one creative of the same adsize within a tactic to get more impressions than another creative.","format":"int32","example":10},"startDate":{"type":"string","description":"A scheduled date for a specific creative to start being used within a tactic.","example":"2025-12-30 23:59:59"},"endDate":{"type":"string","description":"A scheduled date for a specific creative to stop being used within a tactic","example":"2025-12-31 23:59:59"},"scheduleEnabled":{"type":"boolean","description":"Indicates whether the custom scheduling for the creative assignment is enabled.","example":true}},"description":"Creative assignments for the tactic. A tactic will not serve without at least one creative assigned."},"DevicesTargetingResponse":{"type":"object","properties":{"deviceTypes":{"type":"array","description":"List of device types.","example":["mobile","desktop"],"items":{"type":"string","description":"List of device types.","example":"[\"mobile\",\"desktop\"]"}},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified devices.","example":true}},"description":"Devices targeting for the tactic"},"DomainAppsTargetingResponse":{"type":"object","properties":{"domainLists":{"type":"array","description":"List of Domain Lists.","items":{"$ref":"#/components/schemas/DomainListResponse"}},"domains":{"type":"array","description":"List of Individual Domains.","items":{"$ref":"#/components/schemas/IndividualDomainResponse"}},"appLists":{"type":"array","description":"List of App Lists.","items":{"$ref":"#/components/schemas/AppListResponse"}},"apps":{"type":"array","description":"List of Individual Apps.","items":{"$ref":"#/components/schemas/IndividualAppResponse"}}},"description":"Domains and Apps targeting for the tactic"},"DomainListResponse":{"type":"object","properties":{"listId":{"type":"integer","description":"Domain List ID.","format":"int64","example":12345},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified domain list.","example":true}},"description":"List of Domain Lists."},"GeoTargetParentResponse":{"type":"object","properties":{"type":{"type":"string","description":"Type of parent geo target.","example":"country"},"value":{"type":"string","description":"Value of parent geo target.","example":"US"},"parent":{"$ref":"#/components/schemas/GeoTargetParentResponse"}},"description":"Parent geo target."},"GeoTargetsResponse":{"type":"object","properties":{"type":{"type":"string","description":"Type of geo target.","example":"state"},"values":{"type":"array","description":"List of geo target values.","example":["NY","CA"],"items":{"type":"string","description":"List of geo target values.","example":"[\"NY\",\"CA\"]"}},"parent":{"$ref":"#/components/schemas/GeoTargetParentResponse"},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified geo target values.","example":true}},"description":"Geo Targets targeting for the tactic"},"HcpByPractitionerTargetingResponse":{"type":"object","properties":{"crossDevice":{"type":"string","description":"Cross-device tracking.","example":"device"},"npiReporting":{"type":"boolean","description":"If you choose to enable reporting you will be able to access NPI as a dimension in Life Reporting. Note that you will incur a fee","example":true},"segments":{"type":"array","description":"List of segments for HCP by Practitioner targeting.","items":{"$ref":"#/components/schemas/PixelSegmentResponse"}}},"description":"HCP by Practitioner Targeting for the tactic"},"HealthPopulationSegmentResponse":{"type":"object","properties":{"meshCode":{"type":"string","description":"MeshCode of health population segment.","example":"E03.091.080"},"segmentType":{"type":"string","description":"Type of health population segment.","example":"condition"},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified segment.","example":true}},"description":"List of health population segments"},"HealthPopulationsTargetingResponse":{"type":"object","properties":{"crossDevice":{"type":"string","description":"Cross-device tracking.","example":"device"},"operator":{"type":"string","description":"Whether the user needs to be in every selected population (AND) or only one of the selected populations (OR)","example":"AND"},"historicalPeriod":{"type":"string","description":"The historical period in days for health populations targeting.","example":"15","enum":["3","15","90plus"]},"segments":{"type":"array","description":"List of health population segments","items":{"$ref":"#/components/schemas/HealthPopulationSegmentResponse"}}},"description":"Health Populations targeting for the tactic"},"IABNewCategoryResponse":{"type":"object","properties":{"categoryId":{"type":"integer","description":"IAB Category ID.","format":"int64","example":32},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified category.","example":true}},"description":"List of IAB New Categories"},"IABNewCategoryTargetingResponse":{"type":"object","properties":{"categories":{"type":"array","description":"List of IAB New Categories","items":{"$ref":"#/components/schemas/IABNewCategoryResponse"}}},"description":"IAB Categories targeting for the tactic"},"IndividualAppResponse":{"type":"object","properties":{"appName":{"type":"string","description":"App bundle.","example":"com.example.app1"},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified app.","example":true}},"description":"List of Individual Apps."},"IndividualDomainResponse":{"type":"object","properties":{"domainName":{"type":"string","description":"Domain name.","example":"example.com"},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified domain.","example":true}},"description":"List of Individual Domains."},"InventorySourcesTargetingResponse":{"type":"object","properties":{"exchanges":{"uniqueItems":true,"type":"array","description":"List of exchanges.","example":["exchange_1","exchange_2"],"items":{"type":"string","description":"List of exchanges.","example":"[\"exchange_1\",\"exchange_2\"]"}},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified exchanges.","example":true}},"description":"Inventory Sources targeting for the tactic"},"InventoryTypesTargetingResponse":{"type":"object","properties":{"types":{"type":"array","description":"List of inventory types.","example":["app","site"],"items":{"type":"string","description":"List of inventory types.","example":"[\"app\",\"site\"]"}},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified inventory types.","example":true}},"description":"Inventory Types targeting for the tactic"},"MaxSpendPerTacticResponse":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether the max spend per tactic is enabled.","example":true},"amount":{"type":"number","description":"The maximum spend amount for the tactic.","format":"double","example":5000},"period":{"type":"string","description":"The period over which the max spend is calculated.","example":"lifetime","enum":["lifetime","daily"]}},"description":"Maximum spend of the tactic"},"MediaOptimizationResponse":{"type":"object","properties":{"type":{"type":"string","description":"The type of media optimization to be applied for the tactic.","example":"CTR","enum":["CPM","FLAT","CPC","CTR","CPA","Tactic_Reach","LineItem_Reach","Campaign_Reach","Viewability"]},"goal":{"type":"number","description":"The goal value for the specified media optimization type.","format":"double","example":2.5},"conversionPixelId":{"type":"integer","description":"The ID of the conversion pixel associated with CPA media optimization.","format":"int64","example":382920}},"description":"Media optimization settings for the tactic."},"NPIListTargetingResponse":{"type":"object","properties":{"listId":{"type":"integer","description":"The ID of the NPI list.","format":"int64","example":12345},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified NPI list.","example":true}},"description":"NPI Lists targeting for the tactic"},"NPINumbersTargetingResponse":{"type":"object","properties":{"numbers":{"uniqueItems":true,"type":"array","description":"List of NPI numbers.","example":["3137933127","3134730121"],"items":{"type":"string","description":"List of NPI numbers.","example":"[\"3137933127\",\"3134730121\"]"}},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified NPI numbers.","example":true}},"description":"NPI Numbers targeting for the tactic"},"NPITargetingResponse":{"type":"object","properties":{"crossDevice":{"type":"string","description":"Cross-device tracking.","example":"device"},"lists":{"type":"array","description":"NPI Lists targeting for the tactic","items":{"$ref":"#/components/schemas/NPIListTargetingResponse"}},"npiNumbers":{"$ref":"#/components/schemas/NPINumbersTargetingResponse"},"npiReporting":{"type":"boolean","description":"If you choose to enable reporting you will be able to access NPI as a dimension in Life Reporting. Note that you will incur a fee","example":true}},"description":"NPI Targeting for the tactic"},"PixelResponse":{"type":"object","properties":{"pixelId":{"type":"integer","description":"The ID of the retargeting pixel.","format":"int64","example":12345},"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified pixel.","example":true}},"description":"List of retargeting pixels"},"PixelSegmentResponse":{"type":"object","properties":{"include":{"type":"boolean","description":"Indicates whether to include or exclude the specified segment.","example":true},"segmentId":{"type":"integer","description":"The groupId of the practitioner or specialty that you want to include or exclude","format":"int64","example":456},"segmentType":{"type":"string","description":"Type of the segment.","example":"practitioner"}},"description":"List of segments for HCP by Practitioner targeting."},"RetargetingPixelResponse":{"type":"object","properties":{"crossDevice":{"type":"string","description":"Cross-device tracking.","example":"device"},"recency":{"type":"string","description":"Recency in days for the retargeting pixels.","example":"60","enum":["1","7","15","30","60","90","90plus"]},"pixels":{"type":"array","description":"List of retargeting pixels","items":{"$ref":"#/components/schemas/PixelResponse"}}},"description":"Reach retargeting audiences"},"TacticData":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the tactic.","format":"int64","example":67890},"lineItemId":{"type":"integer","description":"The ID of the line item associated with this tactic.","format":"int64","example":12345},"name":{"type":"string","description":"The name of the tactic.","example":"Test Tactic"},"description":{"type":"string","description":"The description of the tactic.","example":"Testing Remarketing."},"enabled":{"type":"boolean","description":"Whether you want the tactic to be enabled or disabled upon creation","example":true},"status":{"type":"string","description":"The status of the tactic.","example":"Incomplete"},"baseBidPrice":{"type":"number","description":"The base bid price for the tactic.","example":10,"default":1},"maxBidPrice":{"type":"number","description":"The maximum bid price for the tactic.","example":25,"default":50},"customFieldSettings":{"type":"array","description":"Custom field configurations for the tactic.","items":{"$ref":"#/components/schemas/CustomFieldSettingResponseData"}},"budgetDistribution":{"$ref":"#/components/schemas/BudgetDistributionResponse"},"maxSpendPerTactic":{"$ref":"#/components/schemas/MaxSpendPerTacticResponse"},"managementFee":{"$ref":"#/components/schemas/ManagementFeeResponseData"},"mediaOptimization":{"$ref":"#/components/schemas/MediaOptimizationResponse"},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapResponseData"},"creativeAssignments":{"type":"array","description":"Creative assignments for the tactic. A tactic will not serve without at least one creative assigned.","items":{"$ref":"#/components/schemas/CreativeAssignmentsResponse"}},"targeting":{"$ref":"#/components/schemas/TargetingResponse"}},"description":"Tactic data"},"TacticResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/TacticData"}}},"TargetingResponse":{"type":"object","properties":{"hcpByPractitioner":{"$ref":"#/components/schemas/HcpByPractitionerTargetingResponse"},"npiTargeting":{"$ref":"#/components/schemas/NPITargetingResponse"},"retargetingPixels":{"$ref":"#/components/schemas/RetargetingPixelResponse"},"behavioralSegments":{"$ref":"#/components/schemas/BehavioralSegmentsTargetingResponse"},"healthPopulations":{"$ref":"#/components/schemas/HealthPopulationsTargetingResponse"},"iabNewCategories":{"$ref":"#/components/schemas/IABNewCategoryTargetingResponse"},"geoTargets":{"type":"array","description":"Geo Targets targeting for the tactic","items":{"$ref":"#/components/schemas/GeoTargetsResponse"}},"authenticBrandSuitability":{"$ref":"#/components/schemas/AuthenticBrandSuitabilityTargetingResponse"},"brandSafetySuitability":{"$ref":"#/components/schemas/BrandSafetySuitabilityTargetingResponse"},"devices":{"$ref":"#/components/schemas/DevicesTargetingResponse"},"domainsApps":{"$ref":"#/components/schemas/DomainAppsTargetingResponse"},"inventorySources":{"$ref":"#/components/schemas/InventorySourcesTargetingResponse"},"inventoryTypes":{"$ref":"#/components/schemas/InventoryTypesTargetingResponse"},"viewability":{"$ref":"#/components/schemas/ViewabilityTargetingResponse"}},"description":"Targeting settings for the tactic."},"ViewabilityTargetingResponse":{"type":"object","properties":{"minViewabilityRate":{"type":"integer","description":"Minimum viewability rate percentage for the targeting.","format":"int32","example":10},"provider":{"type":"string","description":"Viewability provider for the targeting.","example":"DV"}},"description":"Viewability targeting for the tactic"},"CampaignMetaData":{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","example":12345},"name":{"type":"string","example":"Campaign_12345"},"status":{"type":"string","example":"Incomplete"}},"description":"Information about the campaign associated with the created line item"},"CreateLineItemResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/LineItemData"},"meta":{"$ref":"#/components/schemas/CreatedLineItemMetaData"}}},"CreatedLineItemMetaData":{"type":"object","properties":{"campaignInfo":{"$ref":"#/components/schemas/CampaignMetaData"}},"description":"Additional metadata related to the created line item"},"AddOrRemoveNPIsRequest":{"required":["npis","operation"],"type":"object","properties":{"operation":{"type":"string","example":"add","enum":["add","remove"]},"npis":{"uniqueItems":true,"type":"array","example":["3137933127","3134730121"],"items":{"type":"string","example":"[\"3137933127\",\"3134730121\"]"}}}},"UpdateNPIListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/UpdateNPIListResponseData"}}},"UpdateNPIListResponseData":{"type":"object","properties":{"listId":{"type":"integer","description":"NPI List ID","format":"int64","example":42104},"listName":{"type":"string","description":"Name of the NPI list","example":"NPI_42104"},"npisRemoved":{"type":"integer","description":"Number of NPIs removed from the list. Applicable only for remove operation.","format":"int64","example":5},"npisAdded":{"type":"integer","description":"Number of NPIs added to the list. Applicable only for add operation.","format":"int64","example":10},"totalNpis":{"type":"integer","description":"Total number of NPIs in the list after the add/remove/replace operation.","format":"int64","example":50}},"description":"NPI Group Update data"},"AddOrRemoveNPIAttrsRequest":{"required":["operation"],"type":"object","properties":{"operation":{"type":"string","example":"add","enum":["add","remove"]},"attributes":{"type":"array","description":"Column headers. Required for add operation","example":["NPI_ID","Active","CampaignName"],"items":{"type":"string","description":"Column headers. Required for add operation","example":"[\"NPI_ID\",\"Active\",\"CampaignName\"]"}},"attributeValues":{"type":"array","description":"value for corresponding attribute header per NPI. Required for add operation","example":[["1639137706","yes","NPI Targeted Banners"]],"items":{"type":"array","description":"value for corresponding attribute header per NPI. Required for add operation","example":[["1639137706","yes","NPI Targeted Banners"]],"items":{"type":"string","description":"value for corresponding attribute header per NPI. Required for add operation","example":"[[\"1639137706\",\"yes\",\"NPI Targeted Banners\"]]"}}},"npiColumnIndex":{"minimum":0,"type":"integer","description":"which column contains NPIs (Starts with first column = 0). Required for add operation","format":"int32","example":0}}},"NPIGroupAttributeUpdateResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/NPIGroupAttributesUpdateData"}}},"NPIGroupAttributesUpdateData":{"type":"object","properties":{"listId":{"type":"integer","description":"NPI List ID","format":"int64","example":42104},"listName":{"type":"string","description":"Name of the NPI list","example":"NPI_with_Attr"},"npisRemoved":{"type":"integer","description":"Number of NPIs removed from the list. Applicable only for remove operation.","format":"int64","example":5},"npisAdded":{"type":"integer","description":"Number of NPIs added to the list. Applicable only for add operation.","format":"int64","example":10},"rowsAdded":{"type":"integer","description":"Number of NPI Attribute Rows added to the list. Applicable only for add operation.","format":"int64","example":12},"totalNpis":{"type":"integer","description":"Total number of NPIs in the list after the add/remove operation.","format":"int64","example":50},"totalRows":{"type":"integer","description":"Total number of NPI Attribute rows in the list after the add/remove operation.","format":"int64","example":55}},"description":"NPI List Attribute Update data"},"UpdateFlightRequest":{"required":["budget","endDate","id","pacingMode","startDate"],"type":"object","properties":{"id":{"type":"integer","description":"ID of the flight","format":"int64","example":12345},"budget":{"maximum":999999.99,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Flight Budget amount","format":"double","example":50},"startDate":{"type":"string","description":"Flight start datetime","example":"11-01-2025 00:00:00"},"endDate":{"type":"string","description":"Flight end datetime","example":"11-30-2025 22:59:59"},"pacingMode":{"type":"string","description":"Budget pacing strategy","example":"EVEN","enum":["EVEN","ASAP","AHEAD"]},"paceAheadPercent":{"maximum":99,"minimum":1,"type":"integer","description":"Pacing percentage modifier","format":"int32","example":99},"totalImpressionCap":{"maximum":999999999,"minimum":1,"type":"integer","description":"Total Impressions that can serve for a given flight.","format":"int32","example":5000},"dailyImpressionCap":{"maximum":999999999,"minimum":1,"type":"integer","description":"Total impressions that can serve per day on a given flight.","format":"int32","example":1000}},"description":"Flight scheduling and budget"},"UpdateLineItemRequest":{"required":["campaignId","costModel","flights","name"],"type":"object","properties":{"name":{"maxLength":255,"minLength":0,"type":"string","description":"Line item display name","example":"lineItem_12345"},"campaignId":{"type":"integer","description":"The campaign id where you want to add the line item","format":"int64","example":1001},"costModel":{"type":"string","description":"Pricing model.","example":"CPM","enum":["CPM"]},"budgetDistribution":{"type":"string","description":"How should budgets be spent across tactics. Default is Dollars.","example":"Dollars","enum":["Dollars","Percent","Priority"]},"flights":{"type":"array","description":"Flight scheduling and budget","items":{"$ref":"#/components/schemas/UpdateFlightRequest"}}}},"CampaignGroupRequest":{"required":["budgetCap"],"type":"object","properties":{"budgetCap":{"minimum":0,"exclusiveMinimum":true,"type":"number","format":"double","example":20}}},"AdvertiserData":{"type":"object","properties":{"id":{"type":"integer","description":"Advertiser Id","format":"int64","example":987654321},"name":{"type":"string","description":"Advertiser name","example":"Example Advertiser Inc."}},"description":"Advertiser associated with the campaign"},"CampaignGroupData":{"type":"object","properties":{"id":{"type":"integer","description":"Campaign Id","format":"int64","example":12345},"advertiser":{"$ref":"#/components/schemas/AdvertiserData"},"name":{"type":"string","description":"Campaign name","example":"Q1 2024 Brand Awareness Campaign"},"type":{"type":"string","description":"Campaign type","example":"Regular"},"drug":{"$ref":"#/components/schemas/DrugData"},"marketBasketDrug":{"$ref":"#/components/schemas/DrugData"},"diagnosis":{"$ref":"#/components/schemas/DiagnosisData"},"budgetCap":{"type":"number","description":"Campaign budget cap","example":50000},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapResponseData"},"description":{"type":"string","description":"Campaign description","example":"Campaign description with details about objectives and strategy"},"budgetStatus":{"type":"string","description":"Budget approval status","example":"PendingApproval"},"managementFee":{"$ref":"#/components/schemas/ManagementFeeResponseData"},"customFields":{"type":"array","description":"Custom field settings for the campaign","items":{"$ref":"#/components/schemas/CustomFieldSettingResponseData"}},"creativeSeparation":{"$ref":"#/components/schemas/CreativeSeparationData"},"status":{"type":"string","description":"Campaign status","example":"Incomplete"},"createdAt":{"type":"string","description":"Creation timestamp","example":"2024-01-10 13:15:00"},"updatedAt":{"type":"string","description":"Last modified timestamp","example":"2024-01-20 14:45:00"},"createdBy":{"type":"string","description":"User ID who created the campaign","example":"789012"},"updatedBy":{"type":"string","description":"User ID who updated the campaign","example":"789012"}},"description":"Campaign data"},"CampaignGroupResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/CampaignGroupData"}}},"CreativeSeparationData":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether creative separation is enabled","example":false},"campaignIds":{"type":"array","description":"List of campaign IDs in the creative separation group","items":{"type":"integer","description":"List of campaign IDs in the creative separation group","format":"int64"}}},"description":"Creative separation settings for the campaign"},"DiagnosisData":{"type":"object","properties":{"icd10Code":{"type":"string","description":"Diagnosis Id","example":"321654"},"shortDescription":{"type":"string","description":"Diagnosis name","example":"Example Diagnosis"}},"description":"Diagnosis associated with the campaign"},"DrugData":{"type":"object","properties":{"productNdc":{"type":"string","description":"Drug code","example":"drug_456789"},"brandName":{"type":"string","description":"Drug name","example":"Example Drug Name"}},"description":"Market basket drugs associated with the campaign"},"NPIGroupData":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":4210},"name":{"type":"string","example":"NPI_4210"},"advertisers":{"type":"array","example":["Demo"],"items":{"type":"string","example":"[\"Demo\"]"}},"applications":{"type":"array","example":["life","signal"],"items":{"type":"string","example":"[\"life\",\"signal\"]"}},"listType":{"type":"string","description":"NPI List type","example":"attributes","enum":["static","attributes","smartlist","studio"]}},"description":"List of NPI Groups"},"NPIGroupResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/NPIGroupData"}}},"NPIGroupsByAccountIdResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"type":"array","description":"List of NPI Groups","items":{"$ref":"#/components/schemas/NPIGroupData"}}}},"HcpPractictionersSearch":{"type":"object","properties":{"id":{"type":"integer","description":"Practitioner type ID","format":"int64","example":1},"name":{"type":"string","description":"Practitioner type name","example":"Physician"}},"description":"HCP practitioner type"},"HcpPractitionersSearchPagedResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"type":"array","description":"List of result items","items":{"$ref":"#/components/schemas/HcpPractictionersSearch"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseData"}}},"PaginationResponseData":{"type":"object","properties":{"limit":{"type":"integer","description":"Page size limit","format":"int32","example":50},"total":{"type":"integer","description":"Total number of records","format":"int64","example":1250},"has_more":{"type":"boolean","description":"Whether there are more results","example":true},"next_cursor":{"type":"string","description":"Cursor for the next page","example":"eyJpZCI6MTIzNDU2fQ"},"next_cursor_url":{"type":"string","description":"URL for the next page","example":"/RestApi/v2/account/456/creatives?advertiser_id=789&cursor=eyJpZCI6MTIzNDU2fQ&limit=50"}},"description":"Pagination information for cursor-based paging"},"HealthTaxonomyData":{"type":"object","properties":{"meshCode":{"type":"string","description":"MeSH (Medical Subject Headings) taxonomy identifier","example":"D003920"},"name":{"type":"string","description":"Display name of the segment","example":"Diabetes Mellitus"},"description":{"type":"string","description":"Detailed description of the condition or treatment","example":"A metabolic disorder characterized by high blood sugar levels"},"segmentType":{"type":"string","description":"Type of segment: condition or treatment","example":"condition"},"targetingMethods":{"$ref":"#/components/schemas/HealthTaxonomyTargetingMethodsData"},"metadata":{"$ref":"#/components/schemas/HealthTaxonomyMetadataData"}},"description":"Health taxonomy segment (condition or treatment)"},"HealthTaxonomyMetadataData":{"type":"object","properties":{"taxonomyPath":{"type":"string","description":"Full hierarchical path in MeSH taxonomy","example":"Diseases > Nutritional and Metabolic Diseases > Metabolic Diseases"},"isSensitive":{"type":"boolean","description":"Whether this segment is in the sensitive area","example":false}},"description":"Additional metadata about the health taxonomy segment"},"HealthTaxonomyResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"type":"array","description":"List of health taxonomy segments","items":{"$ref":"#/components/schemas/HealthTaxonomyData"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseData"}},"description":"Health taxonomy metadata response with paginated data"},"HealthTaxonomyTargetingMethodsData":{"type":"object","properties":{"audience":{"type":"array","description":"Audience targeting methods that support this segment","example":["healthPopulations","keywordPopulations","healthJourneyPlus","inCondition"],"items":{"type":"string","description":"Audience targeting methods that support this segment","example":"[\"healthPopulations\",\"keywordPopulations\",\"healthJourneyPlus\",\"inCondition\"]"}},"contextual":{"type":"array","description":"Contextual targeting methods that support this segment","example":["healthPages","keywords"],"items":{"type":"string","description":"Contextual targeting methods that support this segment","example":"[\"healthPages\",\"keywords\"]"}}},"description":"Available targeting methods grouped by type"},"HcpSpecialtyData":{"type":"object","properties":{"id":{"type":"integer","description":"Specialty ID","format":"int32","example":101},"name":{"type":"string","description":"Specialty name","example":"Cardiology"},"tier":{"type":"integer","description":"Hierarchy tier (1 = primary, 2 = subspecialty)","format":"int32","example":1},"parent_id":{"type":"integer","description":"Parent specialty ID (null for tier-1 specialties)","format":"int32","example":50},"has_children":{"type":"boolean","description":"Whether this specialty has child subspecialties","example":true},"is_leaf":{"type":"boolean","description":"Whether this specialty is a leaf node with no children","example":false},"children_count":{"type":"integer","description":"Number of child subspecialties","format":"int32","example":3}},"description":"HCP health specialty"},"HealthSpecialtiesResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"type":"array","description":"List of health specialties","items":{"$ref":"#/components/schemas/HcpSpecialtyData"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseData"},"hierarchy":{"$ref":"#/components/schemas/Hierarchy"}},"description":"Health specialties response with paginated data and hierarchy metadata"},"Hierarchy":{"type":"object","properties":{"current_tier":{"type":"integer","description":"The tier level of the current result set","format":"int32","example":1},"available_tiers":{"type":"array","description":"List of tier levels available for navigation","example":[1,2],"items":{"type":"integer","description":"List of tier levels available for navigation","format":"int32"}}},"description":"Hierarchy metadata for the health specialties response"},"GeoTargetCountryInfoData":{"type":"object","properties":{"country_iso":{"type":"string","description":"Country ISO code","example":"usa"},"country_name":{"type":"string","description":"Country display name","example":"United States"}},"description":"Country metadata for a geo-targeting option"},"GeoTargetStateInfoData":{"type":"object","properties":{"state_iso":{"type":"string","description":"State/province ISO code","example":"ca"},"state_name":{"type":"string","description":"State/province display name","example":"California"}},"description":"State/province metadata for a geo-targeting option"},"GeoTargetingOptionData":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the geo-target","format":"int64","example":1234},"name":{"type":"string","description":"Display name of the geo-target","example":"United States"},"type":{"type":"string","description":"Geo-target type","example":"country","enum":["country","state","city","metro"]},"type_id":{"type":"integer","description":"Numeric identifier for the geo-target type","format":"int32","example":1},"iso_code":{"type":"string","description":"ISO code of the geo-target","example":"usa"},"country_info":{"$ref":"#/components/schemas/GeoTargetCountryInfoData"},"state_info":{"$ref":"#/components/schemas/GeoTargetStateInfoData"},"has_children":{"type":"boolean","description":"Whether this geo-target has child entries","example":true},"is_leaf":{"type":"boolean","description":"Whether this geo-target is a leaf node with no children","example":false},"children_count":{"type":"integer","description":"Number of child geo-targets","format":"int64","example":50},"path":{"type":"array","description":"Hierarchy path from root to this geo-target","example":["United States","California"],"items":{"type":"string","description":"Hierarchy path from root to this geo-target","example":"[\"United States\",\"California\"]"}}},"description":"Geographic targeting option"},"GeoTargetingResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"type":"array","description":"List of geo-targeting options","items":{"$ref":"#/components/schemas/GeoTargetingOptionData"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseData"}},"description":"Geo-targeting discovery response with paginated data"},"BrandSuitabilityCategoriesResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/BrandSuitabilityCategoriesResponseData"}},"description":"Brand suitability categories response"},"BrandSuitabilityCategoriesResponseData":{"type":"object","properties":{"data":{"type":"array","description":"List of brand suitability categories","items":{"$ref":"#/components/schemas/BrandSuitabilityCategoryResponseData"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseData"}},"description":"Brand suitability categories response data wrapper"},"BrandSuitabilityCategoryResponseData":{"type":"object","properties":{"id":{"type":"integer","description":"Category ID","format":"int64","example":1791},"providerId":{"type":"string","description":"Provider identifier.","example":"DV","enum":["DV","IAS"]},"name":{"type":"string","description":"Category name","example":"Adult & Sexual - High & Medium Risk"},"parentId":{"type":"integer","description":"Parent category ID, null if root","format":"int64","example":1891},"hasChildren":{"type":"boolean","description":"Whether this category has child categories","example":false},"childrenCount":{"type":"integer","description":"Number of direct children. Present for parent categories.","format":"int32","example":3},"isLeaf":{"type":"boolean"}},"description":"Brand suitability category information"},"BehavioralSegmentResponseData":{"type":"object","properties":{"id":{"type":"string","description":"Segment ID","example":"12345"},"name":{"type":"string","description":"Segment name","example":"In-Market: Auto Buyers"},"provider":{"$ref":"#/components/schemas/ProviderResponseData"},"size":{"type":"integer","description":"Segment size (number of users)","format":"int64","example":1500000},"cpm":{"type":"number","description":"Cost per thousand impressions","format":"double","example":0.75},"currency":{"type":"string","description":"Currency code","example":"USD"}},"description":"Behavioral segment information"},"BehavioralSegmentsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/BehavioralSegmentsResponseData"}},"description":"Behavioral segments response"},"BehavioralSegmentsResponseData":{"type":"object","properties":{"data":{"type":"array","description":"List of behavioral segments","items":{"$ref":"#/components/schemas/BehavioralSegmentResponseData"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseData"}},"description":"Behavioral segments response data wrapper"},"ProviderResponseData":{"type":"object","properties":{"id":{"type":"string","description":"Provider ID","example":"100"},"name":{"type":"string","description":"Provider name","example":"Acme Data Provider"}},"description":"Data provider information"},"BaseLookUpResponse":{"type":"object","properties":{"name":{"type":"string","example":"WhatTest"},"id":{"type":"integer","format":"int64","example":1711}}},"CampaignImportData":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":84727},"name":{"type":"string","example":"Campaign REST API SAMPLE"},"description":{"type":"string","example":"DESCRIPTION"},"advertiser":{"type":"string","example":"01- Advertiser"},"budgetCap":{"type":"string","example":"10000.0"},"account":{"type":"string","example":"123456"},"drugName":{"type":"string","example":"Tylenol PM"},"basketDrugNames":{"type":"array","example":["Tylenol PM"],"items":{"type":"string","example":"[\"Tylenol PM\"]"}},"customFieldSetting":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldSettingImportResponse"}},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItemImportBasicResponse"}},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapImportResponse"},"creativeSeparations":{"type":"array","items":{"$ref":"#/components/schemas/BaseLookUpResponse"}},"approvalStatus":{"type":"string","example":"PendingApproval","enum":["PendingApproval","Approved","Denied"]}},"description":"Campaign Import data"},"CampaignImportResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/CampaignImportData"}}},"CustomFieldSettingImportResponse":{"type":"object","properties":{"fieldId":{"type":"integer","format":"int64","example":14062},"fieldName":{"type":"string","example":"ABC Custom Field"},"fieldValue":{"type":"string","example":"custom field value"}}},"FrequencyCapImportResponse":{"type":"object","properties":{"applyFrequencyCap":{"type":"string","example":"true"},"times":{"type":"string","example":"10"},"period":{"type":"string","example":"day","enum":["day","hour(s)","week","month"]},"hoursValue":{"type":"string","example":"1"},"crossDevice":{"type":"string","example":"Per Device","enum":["Per Device","Per Person","Per Household"]},"untrackable":{"type":"string","example":"false"},"ipUntrackable":{"type":"string","example":"false"}}},"LineItemImportBasicResponse":{"type":"object","properties":{"id":{"type":"string","example":"94019"},"name":{"type":"string","example":"lineitem"}}},"LineItemFlightImportResponse":{"type":"object","properties":{"budget":{"type":"string","example":"200.0"},"startDate":{"type":"string","example":"2024-09-17T00:00:00.000Z"},"endDate":{"type":"string","example":"2024-09-30T23:59:59.000Z"},"pacingMode":{"type":"string","example":"1"},"pacingModePercentage":{"type":"string","example":"12.1"}}},"LineItemImportData":{"type":"object","properties":{"id":{"type":"string","example":"12345"},"name":{"type":"string","example":"LineItem"},"costModel":{"type":"string","example":"CPM"},"cpmPrice":{"type":"string","example":"12.5"},"description":{"type":"string","example":"description"},"flights":{"type":"array","items":{"$ref":"#/components/schemas/LineItemFlightImportResponse"}},"inventoryType":{"type":"string","example":"Display"},"customFieldSetting":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldSettingImportResponse"}},"frequencyCap":{"$ref":"#/components/schemas/LineItemImportFrequencyCapResponse"},"tactics":{"type":"array","items":{"$ref":"#/components/schemas/TacticImportResponse"}}},"description":"Line Item Import data"},"LineItemImportFrequencyCapResponse":{"type":"object","properties":{"times":{"type":"string","example":"10"},"hoursValue":{"type":"string","example":"86400"},"crossDevice":{"type":"string","example":"Device"}}},"LineItemImportResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/LineItemImportData"}}},"TacticImportResponse":{"type":"object","properties":{"id":{"type":"string","example":"00001"},"name":{"type":"string","example":"Tactic"}}},"AdvertiserCampaignData":{"type":"object","properties":{"advertiserId":{"type":"integer","format":"int64","example":1},"advertiserName":{"type":"string","example":"CMIAdvertiser"},"campaignIds":{"type":"array","example":["0001","0002","0003","0004","0005"],"items":{"type":"integer","format":"int64"}}},"description":"Advertiser Campaign data"},"AdvertiserCampaignResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/AdvertiserCampaignData"}}},"AccountAdvertiserData":{"type":"object","properties":{"accountName":{"type":"string","example":"CMI"},"accountId":{"type":"integer","format":"int64","example":1},"advertiserId":{"type":"array","example":["1","2","3"],"items":{"type":"integer","format":"int64"}}},"description":"Account Advertiser data"},"AccountAdvertiserResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/AccountAdvertiserData"}}},"PixelData":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the pixel","format":"int64","example":123456},"name":{"type":"string","description":"Name of the pixel","example":"Rachel Pixel"},"type":{"type":"string","description":"Type of pixel","example":"retargeting","enum":["retargeting","conversion","smart"]},"active":{"type":"boolean","description":"Whether the pixel is active","example":true},"advertiser_id":{"type":"integer","description":"Advertiser ID associated with the pixel","format":"int64","example":1234},"account_id":{"type":"integer","description":"Account ID associated with the pixel","format":"int64","example":323455}},"description":"Pixel data"},"PixelListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/PixelListResponseData"}},"description":"Pixel lookup response"},"PixelListResponseData":{"type":"object","properties":{"data":{"type":"array","description":"List of pixels","items":{"$ref":"#/components/schemas/PixelData"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseData"}},"description":"Pixel list response data wrapper"},"AccountCreativesResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/AccountCreativesResponseData"}},"description":"Account creatives response"},"AccountCreativesResponseData":{"type":"object","properties":{"data":{"type":"array","description":"List of creatives","items":{"$ref":"#/components/schemas/CreativeListResponseData"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseData"}},"description":"Account creatives response data wrapper"},"CreativeListResponseData":{"type":"object","properties":{"crtid":{"type":"integer","description":"Creative ID","format":"int64","example":123456},"addesc":{"type":"string","description":"Creative name/description","example":"Summer Sale Banner"},"landingPageDomain":{"type":"string","description":"Landing page domain","example":"example.com"},"notes":{"type":"string","description":"Notes about the creative"},"archived":{"type":"boolean","description":"Whether the creative is archived","example":false},"enabled":{"type":"boolean","description":"Whether the creative is enabled","example":true},"advertiserId":{"type":"integer","description":"Advertiser ID","format":"int64","example":789},"accountId":{"type":"integer","description":"Account ID","format":"int64","example":456},"height":{"type":"string","description":"Creative height","example":"250"},"width":{"type":"string","description":"Creative width","example":"300"},"createdOn":{"type":"string","description":"Creation timestamp","example":"2024-01-15T10:30:00Z"}},"description":"Creative information"},"DeleteTacticRequest":{"required":["lineItemId"],"type":"object","properties":{"lineItemId":{"type":"integer","description":"The ID of the line item associated with this tactic.","format":"int64","example":12345}}},"DeleteTacticResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/DeletedTactic"}}},"DeletedTactic":{"type":"object","properties":{"lineItemId":{"type":"integer","description":"LineItem ID associated with the deleted tactic","format":"int64","example":12345},"deletedTactic":{"$ref":"#/components/schemas/DeletedTacticDetails"}},"description":"Deleted Tactic details"},"DeletedTacticDetails":{"type":"object","properties":{"tacticId":{"type":"integer","description":"ID of the deleted tactic","format":"int64","example":67890},"tacticName":{"type":"string","description":"Name of the deleted tactic","example":"Sample Tactic"},"deletedAt":{"type":"string","description":"Timestamp when the tactic was deleted","example":"2026-01-01 12:00:00"}}},"DeleteLineItemRequest":{"required":["campaignId"],"type":"object","properties":{"campaignId":{"type":"integer","description":"Campaign ID associated with the line item to be deleted","format":"int64","example":12345}}},"DeleteLineItemImpact":{"type":"object","properties":{"flightsRemoved":{"type":"integer","description":"Number of flights that were removed from the lineitem","format":"int32","example":2},"customFieldsRemoved":{"type":"integer","description":"Number of customfields that were removed from the lineitem","format":"int32","example":5}}},"DeleteLineItemMetaData":{"type":"object","properties":{"impact":{"$ref":"#/components/schemas/DeleteLineItemImpact"}},"description":"Additional metadata related to the deleted line item"},"DeleteLineItemResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Status of the response. True indicates success, false indicates failure","example":true},"message":{"type":"string","description":"Human-readable message describing the result","example":"Operation completed successfully"},"requestId":{"type":"string","description":"Unique identifier for the request","example":"550e8400-e29b-41d4-a716-446655440000"},"data":{"$ref":"#/components/schemas/DeletedLineItem"},"meta":{"$ref":"#/components/schemas/DeleteLineItemMetaData"}}},"DeletedLineItem":{"type":"object","properties":{"lineItemId":{"type":"integer","description":"Id of the deleted line item","format":"int64","example":12345},"lineItemName":{"type":"string","description":"Name of the deleted line item","example":"abc_lineitem"},"deletedAt":{"type":"string","description":"Timestamp when the line item was deleted","example":"2025-12-10 17:30:00"}},"description":"Deleted LineItem details"},"CreateFlightRequest":{"required":["budget","endDate","pacingMode","startDate"],"type":"object","properties":{"budget":{"maximum":999999.99,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Flight Budget amount","format":"double","example":50},"startDate":{"type":"string","description":"Flight start datetime","example":"11-01-2025 00:00:00"},"endDate":{"type":"string","description":"Flight end datetime","example":"11-30-2025 22:59:59"},"pacingMode":{"type":"string","description":"Budget pacing strategy","example":"EVEN","enum":["EVEN","ASAP","AHEAD"]},"paceAheadPercent":{"maximum":99,"minimum":1,"type":"integer","description":"Pacing percentage modifier","format":"int32","example":99},"totalImpressionCap":{"maximum":999999999,"minimum":1,"type":"integer","description":"Total Impressions that can serve for a given flight.","format":"int32","example":5000},"dailyImpressionCap":{"maximum":999999999,"minimum":1,"type":"integer","description":"Total impressions that can serve per day on a given flight.","format":"int32","example":1000},"maxDailySpendOverride":{"$ref":"#/components/schemas/LineItemFlightMaxDailySpendOverrideRequest"}}},"CreateLineItemRequest":{"required":["campaignId","costModel","flights","inventoryType","name","timeZone"],"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string","description":"Line item display name","example":"lineItem_12345"},"campaignId":{"type":"integer","description":"The campaign id where you want to add the line item","format":"int64","example":1001},"costModel":{"type":"string","description":"Pricing model. CPC is allowed only for Native & Search inventory type. 'Fixed CPM' is only available for managed service accounts.","example":"CPM","enum":["CPM","Fixed CPM","CPC"]},"description":{"maxLength":1000,"minLength":1,"type":"string","description":"Line item description","example":"This is a sample line item description."},"inventoryType":{"type":"string","description":"Ad inventory type","example":"Display","enum":["Display","Video","Audio","Native","Search","DOOH","NativeVideo"]},"budgetDistribution":{"type":"string","description":"How budgets should be spent across tactics. Default is Dollars.","example":"Dollars","enum":["Dollars","Percent","Priority"]},"customFieldSettings":{"type":"array","description":"Custom field configurations for the line item","items":{"$ref":"#/components/schemas/CustomFieldSettingRequest"}},"flights":{"type":"array","description":"Break down campaign budgets into discrete time periods","items":{"$ref":"#/components/schemas/CreateFlightRequest"}},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapRequest"},"dayParting":{"$ref":"#/components/schemas/LineItemDayPartingRequest"},"managementFee":{"$ref":"#/components/schemas/ManagementFeeRequest"},"timeZone":{"type":"string","description":"The timezone that the line item should run in","example":"Eastern Time","enum":["Eastern Time","Central Time","Mountain Time","Pacific Time","Greenwich Mean Time","Central European Time","India Standard Time","China Standard Time","Australian Eastern Time","Eastern European Time","Moscow Time","Samara Time","Maldives Time","Omsk Time","Christmas Island Time","Japan Standard Time","Sakhalin Time","New Zealand Time","Azores Time","Argentina Time","Atlantic Time (Canada)","Alaska Time (USA)","Hawaii Time"]}}}},"securitySchemes":{"OAuth2_Password":{"type":"oauth2","description":"OAuth2 Authentication","flows":{"password":{"tokenUrl":"https://lifeapi.pulsepoint.com/RestApi/oauth/token","scopes":{"read":"read access","write":"write access"}}}},"BasicAuth":{"type":"http","description":"Client Credentials Authentication - Enter your client_id as username and client_secret as password.","scheme":"basic"}}}}