Create Partner

POST /partners
Copied
Arrow
                https://api.ocamba.com/v1/hood/partners

Creates a new Partner object

Request Body Schema
Arrow
Name
Description
billing_addressbilling-address
The billing address of the partner.
Billing Address
Name
Description
citystring
City.


Example: Toronto
countrystring
Accepts only valid 2 letter country codes.


Example: ca
postal_codestring
Postal code.


Example: M4C 1A1
streetstring
Street.


Example: 108 Hanson St
contactcontact
The contact of the partner.
Contact
Name
Description
emailstring
The email of the partner.


Example: [email protected]
mobilestring
The mobile phone of the partner.


Example: +15551234567
phonestring
The landline of the partner.


Example: +441632960961
sipstring
The SIP of the partner.


Example: [email protected]
skypestring
The skype contact of the partner.


Example: john.doe123
websitestring
The website of the partner.


Example: https://www.example.com
descriptionstring
The description of the partner.


Example: Example description.
manager_idsarrayrequired
Array of hood member id's created on the Ocamba platform.


Example: 11153151,6643410,3183560
namestringrequired
The name of the partner


Example: Example Partner Name
payment_termspayment-terms
The payment terms to which the partner agreed.
Payment Terms
Name
Description
currency_codestring
Currency code.


Example: usd

Possible values: usd | eur
net_termsstring
Net Terms.


Example: net30

Possible values: net30 | net45 | net60 | net90
payment_frequencystring
The frequency of payment.


Example: annually

Possible values: monthly | quarterly | annually
payment_methodstring
Payment method.


Example: card

Possible values: bank-transfer | card | paypal
statusstringrequired
Describes the status of the partner.


Example: active

Possible values: active | inactive | pending | suspended | terminated
typearrayrequired
Describes the role of the partner.


Example: advertiser

Possible values: advertiser | publisher
Response status codes
Arrow
201 - Created
Arrow
note
1 The billing_address and payment_terms are optional until you fill out at least one field. Once you do, all fields will become required.
Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "manager_ids": [
      "1000220"
  ],
  "name": "test ",
  "description": "test description",
  "type": [
      "publisher"
  ],
  "status": "inactive",
  "payment_terms": {
      "payment_frequency": "quarterly",
      "payment_method": "card",
      "net_terms": "net90",
      "currency_code": "eur"
  },
  "billing_address": {
      "street": "dddddd",
      "city": "test test",
      "post_code": "56-a",
      "country": "RS"
  },
  "contact": {
      "email": "fIS0C1guzHZ6jxidFyOXbFh47nYMzS3ZhUCvKCpwvfuY3s1G9ofAD8sJyjzdWG9J024HroFNBRDg7LNmHiycjBgeUAJ8S13Crgs@fafa.com",
      "mobile": "+785596522",
      "phone": "+1235165336",
      "sip": "5259oskZYi9sw8",
      "skype": "dfa223ghjk",
      "website": "fsf.com"
  }
}
Response examples
Copied
Arrow
201 Arrow
  • 201
{
  "id": "1000412",
  "company_id": "6197120",
  "manager_ids": [
      "1000220"
  ],
  "managers": [
      {
          "id": "1000220",
          "name": "Andj",
          "email": "[email protected]",
          "status": "active"
      }
  ],
  "name": "test qa",
  "description": "d",
  "type": [
      "publisher"
  ],
  "status": "inactive",
  "payment_terms": {
      "payment_frequency": "quarterly",
      "payment_method": "card",
      "net_terms": "net90",
      "currency_code": "eur"
  },
  "billing_address": {
      "street": "dddddd",
      "city": "test test",
      "post_code": "56-a",
      "country": "RS"
  },
  "contact": {
      "email": "fIS0C1guzHZ6jxidFyOXbFh47nYMzS3ZhUCvKCpwvfuY3s1G9ofAD8sJyjzdWG9J024HroFNBRDg7LNmHiycjBgeUAJ8S13Crgs@fafa.com",
      "mobile": "+785596522",
      "phone": "+1235165336",
      "sip": "5259oskZYi9sw8",
      "skype": "dfa223ghjk",
      "website": "fsf.com"
  },
  "system": 0
}