Create a connection

POST  https://:account.api-us1.com/api/3/connections

• JSON

{
  "connection": {
    "service": "fooCommerce",
    "externalid": "toystore123",
    "name": "Toystore, Inc.",
    "logoUrl": "http://example.com/i/foo.png",
    "linkUrl": "http://example.com/foo/"
  }
}

 

200 OK

{
  "connection": {
    "isInternal": 0,
    "service": "fooCommerce",
    "externalid": "toystore123",
    "name": "Toystore, Inc.",
    "logoUrl": "http://example.com/i/foo.png",
    "linkUrl": "http://example.com/foo/",
    "cdate": "2017-02-02T14:56:05-06:00",
    "udate": "2017-02-02T14:56:05-06:00",
    "links": {
      "customers": "/connections/1/customers"
    },
    "id": "1"
  }
}

BODY PARAMS

connection

object

 

connection.service                                   REQUIRED

string                                                        The name of the service.

 

connection.externalid                              REQUIRED

string                                                        The id of the account in the external service.

 

connection.name                                      REQUIRED

string                                                        The name associated with the account in the external service. Often this will be a company name (e.g., 'My Toystore, Inc.').

 

connection.logoUrl                                    REQUIRED

string                                                         The URL to a logo image for the external service.

 

connection.linkUrl                                     REQUIRED

string                                                         The URL to a page where the integration with the external service can be managed in the third-party's website.