Update a connection

PUT  https://:account.api-us1.com/api/3/connections/id

• JSON

{
  "connection": {
    "externalid": "[e-mail]",
    "name": "Acme, Inc."
  }
}

 

200 OK

{
  "connection": {
    "service": "fooCommerce",
    "externalid": "[e-mail]",
    "name": "Acme, Inc.",
    "isInternal": "0",
    "status": "1",
    "syncStatus": "0",
    "logoUrl": "http://foocorp.net/i/path3523.png",
    "linkUrl": "http://example.com/",
    "cdate": "2017-02-02T14:56:05-06:00",
    "udate": "2017-02-03T15:54:51-06:00",
    "links": {
      "customers": "/api/3/connections/2/customers"
    },
    "id": "2"
  }
}

PATH PARAMS

id                                            REQUIRED

string                                      The id of the connection to update

 

BODY PARAMS

connection

object

 

connection.service

string                                      The name of the service.

 

connection.externalid

string                                      The id of the account in the external service.

 

connection.name

string                                      The name associated with the account in the external service.

 

connection.logoUrl

string                                      The URL to a logo image for the third-party service.

 

connection.linkUrl

string                                      The link to the third-party integrator's site.

 

connection.status

int32                                       The status of the connection (0 = error; 1 = connected)

 

connection.syncStatus

int32                                       The status of a sync triggered on the connection (0 = sync stopped; 1 = sync running).