POST syncNewAccountToExternalSystem
POST /account
Creates the Account entity.
Request body
Media type: application/json. Schema: Create_Account.
The Account to create.
Example
{
"requestId": "RQST00001",
"requestedBy": "Bianca White",
"requestI18NInfo": {
"localeName": "United States",
"localeCode": "en-us",
"timezone": "Apia Standard Time (Pacific/Apia)",
"currencyName": "United States Dollar",
"currencyCode": "USD"
},
"requestMode": "Minimal",
"adServerInstanceId": "INS0491032",
"adServerCode": "Wide-Orbit",
"adServerApplicationName": "Wide-Orbit",
"accounts":
[
{
"id": "",
"tentativeMappingId": "8f651263-0478-49ea-8811-153xxxxxx784",
"accountType": "advertiser",
"accountName": "Acme Global Test2",
"description": "This is Acme Global Account based in US",
"adServerUserId": "c7890ffa-bd35-f3ef-38f8-4c649xxxxxxf",
"accountNumber": "AC00xxx13",
"numberOfEmployees": 25000,
"industry": "Consumption-Beverage",
"parentId": "c7890ffa-bd35-f3ef-38f8-4c649xxxxxxf",
"rating": "hot",
"website": "http://www.acmeexample.com",
"phone": "0000000000",
"billingAddress": {
"line1": "312 Line 1",
"line2": "Address Line 2",
"line3": "Line 3",
"city": "Austin",
"state": "TX",
"zipCode": "78767",
"country": "USA"
},
"shippingAddress": {
"line1": "312 Line1",
"line2": "Constitution Place",
"line3": "Line 3",
"city": "Austin",
"state": "TX",
"zipCode": "78767",
"country": "USA"
},
"accountCode": "00xxx000xxxxk30YAD",
"status": "InActive",
"relatedAccounts": [],
"additionalFields": {},
"attributes": {
"careOf": "careOfExample",
"externalId": "",
"statementEmailAddress": "xyz@example.com",
"isPending": false
}
}
]
}Responses
- 200
The Account entity was created.
Media type:
application/json. Schema:Create_Account_Response.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491032", "result": { "status": "success", "code": 200, "additionalStatus": {}, "shortMessage": "", "verboseMessage": "" }, "addtionalInfo": [], "minimalResults": [ { "AC00xxx13": "8f651263-0478-49ea-8811-15323b9c9784" } ], "detailResults": [] } - 400
There was an issue with your request.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 400, "additionalStatus": { "c7890ffa-bd35-f3ef-38f8-4c649xxxxxxf": { "errorMessage": "", "Related Accounts": [ { "accountId": "00xxx000xxxxk30YEX", "errorMessage": "" }, {} ] } }, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "BAD_REQUEST", "verboseMessage": "Errors: /items/0 required key [startDate] not found." }, "addtionalInfo": [], "minimalResults": [], "detailResults": [], "additionalFields": [] } - 401
Authorization failed.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 401, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Unauthorised", "verboseMessage": "Credentials are incorrect." }, "addtionalInfo": [], "minimalResults": [], "detailResults": [], "additionalFields": [] } - 403
Request forbidden.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 403, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Forbidden", "verboseMessage": "Request forbidden." }, "addtionalInfo": [], "minimalResults": [], "detailResults": [], "additionalFields": [] } - 404
Resource not found.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 404, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "NotFound", "verboseMessage": "Resource not found." }, "addtionalInfo": [], "minimalResults": [], "detailResults": [], "additionalFields": [] } - 405
Method not allowed.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 405, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Method Not Allowed", "verboseMessage": "Method not allowed for this resource." }, "addtionalInfo": [], "minimalResults": [], "detailResults": [], "additionalFields": [] } - 422
Unprocessable entity.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 422, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Unprocessable Content", "verboseMessage": "Requested content can't be processed." }, "addtionalInfo": [], "minimalResults": [], "detailResults": [], "additionalFields": [] } - 500
Unable to complete the request as the server encountered an error.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 500, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Internal Server Error", "verboseMessage": "The server encountered an unexpected condition that prevented it from fulfilling the request." }, "addtionalInfo": [], "minimalResults": [], "detailResults": [], "additionalFields": [] }