PATCH
/
v2
/
sources
/
{id}
curl --request PATCH \
  --url https://api.portable.io/v2/sources/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 80562,
  "displayName": "",
  "sourceSpec": {
    "name": "freshsales",
    "instructions": "**API Key:** Each user in Freshsales is provided with a unique API key. To find your API key\n\n1. Click your profile picture and select Profile Settings.\n2. Click the API Settings tab.\n3. You can find your API key in the field Your API key.\n\n**Subdomain:** Your subdomain is found in the URL when you visit Freshsales. For instance, if you visit \"https://example.myfreshworks.com/crm/sales\", your subdomain is just '\''example'\''.\n\n**Account View ID:** By default, we iterate through all account views to find your accounts. If you have a single account view ID (likely the one that corresponds to All Accounts) that you would like us to use to pull accounts, you can enter the ID here.",
    "propertyDefinitions": [
      {
        "name": "domain",
        "type": "string",
        "required": true,
        "description": "Subdomain"
      },
      {
        "name": "api_key",
        "type": "password",
        "required": true,
        "description": "API Key"
      },
      {
        "name": "account_view_id",
        "type": "string",
        "required": false,
        "description": "Account View ID (If you only want to pull accounts from one view i.e. 12006154448)"
      }
    ]
  },
  "properties": {
    "domain": "veradata-3625884588",
    "api_key": "********"
  },
  "createdAt": "2023‐06‐12T20:03:00Z",
  "updatedAt": "2023-08-01T00:00:00Z"
}'
{
  "data": {
    "id": 80562,
    "displayName": "",
    "sourceSpec": {
      "name": "freshsales",
      "instructions": "**API Key:** Each user in Freshsales is provided with a unique API key. To find your API key\n\n1. Click your profile picture and select Profile Settings.\n2. Click the API Settings tab.\n3. You can find your API key in the field Your API key.\n\n**Subdomain:** Your subdomain is found in the URL when you visit Freshsales. For instance, if you visit \"https://example.myfreshworks.com/crm/sales\", your subdomain is just 'example'.\n\n**Account View ID:** By default, we iterate through all account views to find your accounts. If you have a single account view ID (likely the one that corresponds to All Accounts) that you would like us to use to pull accounts, you can enter the ID here.",
      "propertyDefinitions": [
        {
          "name": "domain",
          "type": "string",
          "required": true,
          "description": "Subdomain"
        },
        {
          "name": "api_key",
          "type": "password",
          "required": true,
          "description": "API Key"
        },
        {
          "name": "account_view_id",
          "type": "string",
          "required": false,
          "description": "Account View ID (If you only want to pull accounts from one view i.e. 12006154448)"
        }
      ]
    },
    "properties": {
      "domain": "veradata-3625884588",
      "api_key": "********"
    },
    "createdAt": "2023‐06‐12T20:03:00Z",
    "updatedAt": "2023-08-01T00:00:00Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer
required

ID

Example:

568971

Body

application/json
Source to update
​
displayName
string

A human-readable name for the source

​
properties
object

Response

200
application/json
OK
​
data
object
required
Example:
{
  "$ref": "#/components/examples/sourceGcal/value"
}
Delete sourceVerify if a source is properly configured