Create Account

POST /accounts
Copied
Arrow
                https://api.ocamba.com/v2/adex/accounts

Creates a new Account object

Request Body Schema
Arrow
Name
Description
contacts[ contact ]
List of contact objects.
Contact
Name
Description
idstring (uuid)
A unique identifier generated by the Ocamba platform.


Example: 95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b
typestring
Describes type of the contact.


Example: email

Possible values: phone | mobile | skype | sip | email | website
valuestring
Contact value.


Example: [email protected]
feedsobject

Name
Description
postbacksstring



Example: https://google.com
namestringrequired
Name of the account.


Example: Demo_account
statusstringrequired
The status reflects the current status of the account which may be overridden by some background processes.


Example: active

Possible values: active | verification | rejected | paused | inactive | archived | hourly-limit | daily-limit | monthly-limit

Default: active
Response status codes
Arrow
201 - Created
Arrow
Name
Description
contacts[ contact ]
List of contact objects.
Contact
Name
Description
idstring (uuid)
A unique identifier generated by the Ocamba platform.


Example: 95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b
typestring
Describes type of the contact.


Example: email

Possible values: phone | mobile | skype | sip | email | website
valuestring
Contact value.


Example: [email protected]
feedsobject

Name
Description
postbacksstring



Example: https://google.com
namestringrequired
Name of the account.


Example: Demo_account
statusstringrequired
The status reflects the current status of the account which may be overridden by some background processes.


Example: active

Possible values: active | verification | rejected | paused | inactive | archived | hourly-limit | daily-limit | monthly-limit

Default: active
tip
1 Image upload can only be accomplished using the multipart/form-data, as shown in the example two.
Request examples
Copied
Arrow
200 Arrow
  • 200
{
 "name":"new account",
 "status":"active",
 "contacts":[
   {
    "type":"email",
    "value":"[email protected]"
   }
 ],
 "feeds":
   {
    "postbacks":"test123"
   }
 }
Response examples
Copied
Arrow
201 Arrow
  • 201
{
  "id": "52794322",
  "company_id": "1234123",
  "creator_id": "1235523",
  "status": "active",
  "configured_status": "active",
  "name": "Demo_account",
  "image": "https://path/logo.jpeg",
  "contacts": [
    {
      "id": "95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b",
      "value": "[email protected]",
      "type": "email"
    }
  ],
  "feeds": {
    "postbacks": "https://google.com"
  },
  "is_default": 1,
  "create_time": "2021-10-29 12:47:00",
  "update_time": "2021-10-30 14:27:26"
}