POST Project
Overview
The following table contains important information about the POST
method in regards to posting a project.
POST Project | |
---|---|
Method | POST |
URL or Endpoint | /organizations/organizationId /projects |
Headers | Authorization |
Parameters | Not Applicable |
Body | name |
The description of the URL parameters is as follows:
URL Parameter | |
---|---|
Parameter Name | organizationId |
Mandatory | Yes |
Type | string |
Description | The ID of your project |
Request Body
{
"name": "John's project"
}
Information about the fields that appear in the request body are displayed in the table below.
Request Body | |
---|---|
Field Name | name |
Mandatory | Yes |
Type | string |
Description | Name of the project. |
Response
{
"success": true,
"errors": [],
"messages": ["Project created successfully!"],
"result": {
"publicProjectId": "agmippmb",
"name": "John's project",
"publicOrganizationId": "odgehtyp",
"orderNumber": 0,
"isDefault": true,
"biskoId": "string",
"prebidConfigId": "string"
},
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
Field Name | Type | Description |
---|---|---|
success | bool | If the response is successful it will return true. Otherwise will return false. |
errors | array[] | Indicates if there was an error. |
messages | array[] | Returns the response message from back-end. |
result | array[Object] | Returns the response object. |
publicProjectId | string | The id of the project. |
name | string | The name of the project |
publicOrganizationId | string | The id of the organization |
orderNumber | integer($int32) | The order number. |
isDefault | bool | Indicates whether the project is a default project. |
biskoId | string | The Bisko ID. |
prebidConfigId | string | The configuration ID of the prebid. |
resultInfo | string | Returns extra information about the result. |
statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed