Create Account

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

Creates a new Account object

Request Body Schema
Arrow
Name
Description
contacts[ account-contact ]
List of account contacts.
Account 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
The actual contact, based on contact type. For example, if contact type is email, the value must be a valid email address.


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 | lifetime-limit

Default: active
Response status codes
Arrow
201 - Created
Arrow
Request examples
Copied
Arrow
200 Arrow
  • 200
{
 "name":"new account",
 "status":"active",
 "contacts":[
   {
    "type":"email",
    "value":"[email protected]"
   }
 ],
 "feeds":
   {
    "postbacks":"test123"
   }
 }