gainsight-px-rest-api
POST /v1/external_segment/update_membership

Updates External Segment membership

application/json

Body Required

Segment Payload

  • add array[object] Required

    List of segments to add

    Hide add attributes Show add attributes object

    Segment action containing segment ID, qualification time, and identities

    • identities array[string] Required

      List of user identity IDs

    • lastQualificationTime string Required

      Last qualification time in ISO 8601 format

    • segmentId string Required

      Segment ID

  • identityType string

    Identity type for all identities

    Values are IDENTIFY_ID or GLOBAL_ID.

  • remove array[object] Required

    List of segments to remove

    Hide remove attributes Show remove attributes object

    Segment action containing segment ID, qualification time, and identities

    • identities array[string] Required

      List of user identity IDs

    • lastQualificationTime string Required

      Last qualification time in ISO 8601 format

    • segmentId string Required

      Segment ID

Responses

  • 200

    Success

  • 400

    Bad request, possible duplicate

  • 401

    Unauthorized or bad API Key

  • 429

    Rate limit exceeded

POST /v1/external_segment/update_membership 
curl \
 --request POST 'https://api.aptrinsic.com/v1/external_segment/update_membership' \
 --header "Content-Type: application/json" \
 --data '{"add":[{"identities":["string"],"lastQualificationTime":"2023-01-12T00:25:15.269332Z","segmentId":"21d7ef5a-77ac-43d0-80c5-0ce1871a5ec7"}],"identityType":"IDENTIFY_ID","remove":[{"identities":["string"],"lastQualificationTime":"2023-01-12T00:25:15.269332Z","segmentId":"21d7ef5a-77ac-43d0-80c5-0ce1871a5ec7"}]}'
Request examples 
{
  "add": [
    {
      "identities": [
        "string"
      ],
      "lastQualificationTime": "2023-01-12T00:25:15.269332Z",
      "segmentId": "21d7ef5a-77ac-43d0-80c5-0ce1871a5ec7"
    }
  ],
  "identityType": "IDENTIFY_ID",
  "remove": [
    {
      "identities": [
        "string"
      ],
      "lastQualificationTime": "2023-01-12T00:25:15.269332Z",
      "segmentId": "21d7ef5a-77ac-43d0-80c5-0ce1871a5ec7"
    }
  ]
}