Call a connector method

You can use the MethodUniqueIdentifier and an Account API ID to call a connector method and get the response from a third-party application.

Note: Some Connector Methods alter the format of the response returned by the third-party API to improve how it works with Cyclr.

Request

CODE

POST https://{CyclrAPIDomain}/v1.0/account/connectors/{AccountConnectorID}/methods/{MethodIdentifier}
Authorization: Bearer {AccessToken}
Content-Type: application/json
X-Cyclr-Account: {AccountAPIID}

{}

Request parameters

Parameter	Description
`{CyclrAPIDomain}`	Replace with the appropriate API domain for your Partner Console.
`{AccountConnectorID}`	Replace with an account connector ID. See Get account connectors.
`{MethodIdentifier}`	Replace with an ID for a method, either the numeric ID of the MethodUniqueIdentifier. See Get connector methods.
`{AccessToken}`	Your Cyclr API access token.
`{AccountAPIID}`	The API ID of the account to work in.

Note: It’s more reliable to use the Method Unique Identifier as the method ID can change between releases.

Pass parameters with a request

If the method you are calling requires any values to be passed, you can include them in your request body:

CODE

POST https://{CyclrAPIDomain}/v1.0/account/connectors/{accountConnectorID}/methods/{MethodIdentifier}
Authorization: Bearer {AccessToken}
Content-Type: application/json
X-Cyclr-Account: {AccountAPIID}

{
    "Parameters": {
        "400123": "true"
    },
    "Fields": {
        "500123": "example.com"
    }
}

Example response

JSON

{
    "records": [
        {
            "Id": "1001",
            "FirstName": "John",
            "LastName": "Doe",
            "Name": "John Doe",
            "Email": "johndoe@example.com"
        },
        {
            "Id": "1002",
            "FirstName": "Jane",
            "LastName": "Doe",
            "Name": "Jane Doe",
            "Email": "janedoe@example.com"
        }
    ]
}