gainsight-px-rest-api
POST /v1/accounts

Creates a new account with the given data

application/json

Body Required

Account data

  • id string Required
  • name string Required
  • trackedSubscriptionId string
  • sfdcId string
  • lastSeenDate integer(int64)
  • dunsNumber string
  • industry string
  • numberOfEmployees integer(int32)
  • sicCode string
  • website string
  • naicsCode string
  • plan string
  • location object

    Location object

    Hide location attributes Show location attributes object
    • countryName string
    • countryCode string

      See ISO 3166

    • stateName string
    • stateCode string

      See ISO 3166

    • city string
    • street string
    • postalCode string
    • continent string

      See ISO 3166

    • regionName string

      See ISO 3166-2

    • timeZone string
    • coordinates object

      Coordinates object

      Hide coordinates attributes Show coordinates attributes object
      • latitude number(double)
      • longitude number(double)
  • propertyKeys array[string] Required

    Aptrinsic Tag Key, at least one is required

  • customAttributes object

    Map of apiName to value

  • parentGroupId string

    Id to group Accounts together

  • renewalDate integer(int64)
  • healthScore integer(int32)
  • gsId string
  • nps number(float)
  • csm string

Responses

  • 201 */*

    Created Account

    Hide response attributes Show response attributes object
    • body object
    • statusCode string

      Values are 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, or 511.

    • statusCodeValue integer(int32)
  • 400

    Bad request, possible duplicate

  • 401

    Unauthorized or bad API Key

  • 429

    Rate limit exceeded

POST /v1/accounts 
curl \
 --request POST 'https://api.aptrinsic.com/v1/accounts' \
 --header "Content-Type: application/json" \
 --data '{"id":"string","name":"string","trackedSubscriptionId":"string","sfdcId":"string","lastSeenDate":42,"dunsNumber":"string","industry":"string","numberOfEmployees":42,"sicCode":"string","website":"string","naicsCode":"string","plan":"string","location":{"countryName":"United States","countryCode":"USA","stateName":"California","stateCode":"CA","city":"San Mateo","street":"101 Broadway","postalCode":94010,"continent":"NA","regionName":"string","timeZone":"string","coordinates":{"latitude":37.567147,"longitude":-122.324211}},"propertyKeys":["AP-XXXXXXXXXX-2"],"customAttributes":{},"parentGroupId":"string","renewalDate":42,"healthScore":42,"gsId":"string","nps":42.0,"csm":"string"}'
Request examples 
{
  "id": "string",
  "name": "string",
  "trackedSubscriptionId": "string",
  "sfdcId": "string",
  "lastSeenDate": 42,
  "dunsNumber": "string",
  "industry": "string",
  "numberOfEmployees": 42,
  "sicCode": "string",
  "website": "string",
  "naicsCode": "string",
  "plan": "string",
  "location": {
    "countryName": "United States",
    "countryCode": "USA",
    "stateName": "California",
    "stateCode": "CA",
    "city": "San Mateo",
    "street": "101 Broadway",
    "postalCode": 94010,
    "continent": "NA",
    "regionName": "string",
    "timeZone": "string",
    "coordinates": {
      "latitude": 37.567147,
      "longitude": -122.324211
    }
  },
  "propertyKeys": [
    "AP-XXXXXXXXXX-2"
  ],
  "customAttributes": {},
  "parentGroupId": "string",
  "renewalDate": 42,
  "healthScore": 42,
  "gsId": "string",
  "nps": 42.0,
  "csm": "string"
}
Response examples (201) 
{
  "body": {},
  "statusCode": "100",
  "statusCodeValue": 42
}