Lists

The segments endpoint provides access to lists where you can organize and manage contacts.

Creates a Segment resource.

post

Creates a Segment resource.

Authorizations

BearerAuthApiKeyAuth

Body

application/ld+jsonapplication/json

idstring · nullableOptional

titlestring · nullableRequired

iconstring · nullableRequired

sequenceinteger · nullableOptional

Responses

201

Segment resource created

application/ld+jsonapplication/json

@contextone ofOptional

stringOptional

or

@idstringRequired

@typestringRequired

idstring · nullableOptional

titlestring · nullableRequired

iconstring · nullableRequired

sequenceinteger · nullableOptional

400

Invalid input

application/ld+jsonapplication/problem+jsonapplication/json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

422

An error occurred

application/ld+jsonapplication/problem+jsonapplication/json

post

/segments

HTTPcURLJavaScriptPython

POST /segments HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 52

{
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}

application/ld+jsonapplication/json

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}

Retrieves a Segment resource.

get

Retrieves a Segment resource.

Authorizations

BearerAuthApiKeyAuth

Path parameters

idstringRequired

Segment identifier

Responses

200

Segment resource

application/ld+jsonapplication/json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

404

Not found

application/ld+jsonapplication/problem+jsonapplication/json

get

/segments/{id}

HTTPcURLJavaScriptPython

GET /segments/{id} HTTP/1.1
Host: api.rogerroger.io
Accept: */*

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}

Updates the Segment resource.

patch

Updates the Segment resource.

Authorizations

BearerAuthApiKeyAuth

Path parameters

idstringRequired

Segment identifier

Body

application/merge-patch+json

idstring · nullableOptional

titlestring · nullableOptional

iconstring · nullableOptional

sequenceinteger · nullableOptional

Responses

200

Segment resource updated

application/ld+jsonapplication/json

400

Invalid input

application/ld+jsonapplication/problem+jsonapplication/json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

404

Not found

application/ld+jsonapplication/problem+jsonapplication/json

422

An error occurred

application/ld+jsonapplication/problem+jsonapplication/json

patch

/segments/{id}

HTTPcURLJavaScriptPython

PATCH /segments/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 52

{
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}

Replaces the Segment resource.

put

Replaces the Segment resource.

Authorizations

BearerAuthApiKeyAuth

Path parameters

idstringRequired

Segment identifier

Body

application/ld+jsonapplication/json

idstring · nullableOptional

titlestring · nullableRequired

iconstring · nullableRequired

sequenceinteger · nullableOptional

Responses

200

Segment resource updated

application/ld+jsonapplication/json

400

Invalid input

application/ld+jsonapplication/problem+jsonapplication/json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

404

Not found

application/ld+jsonapplication/problem+jsonapplication/json

422

An error occurred

application/ld+jsonapplication/problem+jsonapplication/json

put

/segments/{id}

HTTPcURLJavaScriptPython

PUT /segments/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 52

{
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}

application/ld+jsonapplication/json

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "title": null,
  "icon": null,
  "sequence": null
}

Retrieves the collection of Segment resources.

get

Retrieves the collection of Segment resources.

Authorizations

BearerAuthApiKeyAuth

Query parameters

pageintegerOptional

The collection page number

Default: 1

itemsPerPageinteger · max: 30Optional

The number of items per page

Default: 15

Responses

200

Segment collection

application/ld+jsonapplication/json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

get

/segments

HTTPcURLJavaScriptPython

GET /segments HTTP/1.1
Host: api.rogerroger.io
Accept: */*

{
  "member": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "id": null,
      "title": null,
      "icon": null,
      "sequence": null
    }
  ],
  "totalItems": 1,
  "view": {
    "@id": "string",
    "type": "string",
    "first": "string",
    "last": "string",
    "previous": "string",
    "next": "string"
  },
  "search": {
    "@type": "text",
    "template": "text",
    "variableRepresentation": "text",
    "mapping": [
      {
        "@type": "text",
        "variable": "text",
        "property": null,
        "required": true
      }
    ]
  }
}