Update Integration

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

Updates a specific Integration 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
namestring
The Name of the integration. A string of minimal 1 and maximal 100 characters.


Example: My First Integration
settingstwilio-integration

custom-email-integration

mandrill-integration

sendgrid-integration

mitto-integration

mailgun-integration

telegram-integration
The settings of the integration. These are specific by provider. The input params differ by provider.
twilio_sms
Name
Description
account_sidstring
A Twilio Account SID is a 34-character alphanumeric identifier that can be found on the dashboard when logging into the Twilio Console.


Example: ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
auth_tokenstring
The Auth Token is a secret key that used by Twilio to authenticate API requests that can be found on the dashboard when logging into the Twilio Console.


Example: Jd4pbV9BtHC6Q9EdymQhZ4aJgZ8AgFi9
default_phone_numberstring
Twilio phone number


Example: +14155552671
custom_email_provider
Name
Description
default_sender_emailstring
The 'from' email address.


Example: [email protected]
default_sender_namestring
The name that will be displayed as the sender name.


Example: John Doe
passwordstring
The password for your email account registered on the email domain you've specified.


Example: yourExamplePassword123
portstring
The SMTP port your email domain uses.


Example: 587
sending_domainstring
Email domain.


Example: ex.example.com
usernamestring
The username registered on your email domain through which you're actually sending the email.


Example: [email protected]
mandrill_email
Name
Description
api_keystring
A Mandrill Account API key. Provided to you by the Mandrill platform


Example: ad-79XXXXXXXXXXXXXXXXXXXXXX
default_reply_to_emailstring
The reply-to email address that will be displayed in the email.


Example: [email protected]
default_sender_emailstring
The email address which will be the actual sender of the notification


Example: [email protected]
default_sender_namestring
The name that will be displayed as the sender name


Example: John Doe
smtp_usernamestring
The SMTP host name for Mandrill.


Example: exampleName
sendgrid_email
Name
Description
api_keystring
A Mandrill Account API key. Provided to you by the SendGrid platform.


Example: SG.EGXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX
default_reply_to_emailstring
The reply-to email address that will be displayed in the email. If the reply-to email is provided, it has to match the reply-to email from your SendGrid account.


Example: [email protected]
default_sender_emailstring
The email address which will be the actual sender of the notification. This has to match the sender email from your SendGrid account.


Example: [email protected]
default_sender_namestring
The name that will be displayed as the sender name.


Example: John Doe
mitto_sms
Name
Description
sender_namestring
The name of the sender that will be displayed to the user receiving the message.


Example: Ocamba Integration
mailgun_email
Name
Description
api_keystring
A Mailgun Account API key. Provided to you by the Mailgun platform.


Example: 563cXXXXXXXXXXXXXXXXXXX-XXXXXXXXX-XXXXXXXXX
domainstring
The domain of your Mailgun account. Provided to you by the Mailgun platform.


Example: sandboxXXXXXXXXXXXXXXXXXXXXXXXXX.mailgun.org
sender_emailstring
The email address which will be the actual sender of the notification.


Example: [email protected]
sender_namestring
The sender name that will appear when a user recieves the email.


Example: John Doe
telegram
Name
Description
auth_tokenstring
A telegram bot authentication token. Provided by the telegram API.


Example: 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
chat_idstring
A telegram unique chat identifier. Provided by the telegram API.


Example: 8171131924
statusstring
The status of the integration. Active integrations can be used to send SMS messages.


Example: active

Possible values: active | inactive
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.
tip
1 If you don't know the Integration 'id', list the Integrations to find it.
warning
1 The settings substructure differs based on provider id. Every field that does not belong the provider specified by the provider id will be omitted.

Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "name": "Test Patch",
  "status": "active",
  "settings": 
  {
    "account_sid": "ACfXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "auth_token": "f9cXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "default_phone_number":"1324XXXXXXXX"
  },
}