Jump to

• Request
• Response
• Examples

Retrieve a contact segment

get

/api/bulk/2.0/contacts/segments/{id}

Retrieves a contact segment.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id(required): integer
  Part of the uri used to identify the contact segment.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : ContactSegmentIndividualResponse

Type: object

Title: ContactSegmentIndividualResponse

The response body contains information about the contact segment definition.

Show Source

• count: integer
  Title: count

  The number of items returned. In items: the number of records operated on for that message.
• createdAt: string(date-time)
  Title: createdAt

  The date and time the contact segment was created, expressed using the ISO-8601 standard. This is a read-only property.
• createdBy: string
  Title: createdBy

  The login id of the user who created the contact segment. This is a read-only property.
• executedAt: string(date-time)
  Title: executedAt

  The time and date the contact segment was last used.
• name: string
  Title: name

  The contact list's name.
• statement: string
  Title: statement

  The markup language statement used to reference the field in an import or export mapping.
• updatedAt: string(date-time)
  Title: updatedAt

  The date and time the contact segment was last updated, expressed using the ISO-8601 standard.
• updatedBy: string
  Title: updatedBy

  The login id of the user that last updated the contact segment.
• uri: string
  Title: uri

  System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

{
    "title":"ContactSegmentIndividualResponse",
    "description":"The response body contains information about the contact segment definition.",
    "properties":{
        "count":{
            "title":"count",
            "description":"The number of items returned.\r\n\r\nIn items: the number of records operated on for that message.",
            "type":"integer"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"The date and time the contact segment was created, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"The login id of the user who created the contact segment. This is a read-only property.",
            "type":"string"
        },
        "executedAt":{
            "format":"date-time",
            "title":"executedAt",
            "description":"The time and date the contact segment was last used.",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"The contact list's name.",
            "type":"string"
        },
        "statement":{
            "title":"statement",
            "description":"The markup language statement used to reference the field in an import or export mapping.",
            "type":"string"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"The date and time the contact segment was last updated, expressed using the ISO-8601 standard.",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"The login id of the user that last updated the contact segment.",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
            "type":"string"
        }
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.

Back to Top

Examples

Retrieve the segment with id = 3:

GET /contacts/segments/3
			

Response:

{
    "name":"Sandwich Crew",
    "count":0,
    "statement":"{{ContactSegment[3]}}",
    "uri":"/contacts/segments/3",
    "createdBy":"SandwichMan",
    "createdAt":"2015-05-28T19:33:45.5300000Z",
    "updatedBy":"MgrPlatformTeamPod1",
    "updatedAt":"2015-05-28T20:08:35.2770000Z"
}
			

Back to Top