Update Partner

PATCH /partners/{id}
Copied
Arrow
                https://api.ocamba.com/v1/hood/partners/{id}

Updates a specific Partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
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_idsarray
Array of hood member id's created on the Ocamba platform.


Example: 11153151,6643410,3183560
namestring
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
statusstring
Describes the status of the partner.


Example: active

Possible values: active | inactive | pending | suspended | terminated
Response status codes
Arrow
204 - No Content
Arrow

note
1 At least one of the updatable fields should be sent via HTTP body in order to change the current state of the integration.
2 The billing_address and payment_terms are optional until you fill out at least one field. Once you do, all fields will become required.
tip
1 If you don't know the Partner 'id', list the Partners to find it.
warning
1 Please note that updating the Partner status will also lead to updating the status of it's related resources. So the Deals to which the Partner is attached will have the same status set as effective, as well as Campaigns effective status.

Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "manager_ids": [
      "1000220"
  ],
  "name": "test ",
  "description": "test description",
  "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"
}