Powered by Redocly

Contact points

Manage a customer's contact points.

Contact point

A contact point-object is a reference to a location for contact.

id
string <uuid>

Contact point identifier.

customer_id
string <uuid>

Identifier of the customer the contact point belongs to.

email_address
string or null <email> [ 0 .. 255 ] characters

Email address.

label
string [ 0 .. 255 ] characters

Contactpoint label.

location_id
string or null <uuid>

Identifier for the location of the contact point.

phone_number
string [ 0 .. 32 ] characters

Phone number.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "email_address": "support@jifeline.com",
  • "label": "Customer support",
  • "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
  • "phone_number": "+31611111111"
}

Retrieve contact points

Retrieve a list of customer contact points.

SecurityOAuth2 and ApiKey
Request
query Parameters
customer_id
string <uuid>

Filter contact points by customer_id.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

location_id
string <uuid>

Filter contact points by location identifier.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Contact point) >= 0 items

List of contact points.

Array (>= 0 items)
id
string <uuid>

Contact point identifier.

customer_id
string <uuid>

Identifier of the customer the contact point belongs to.

email_address
string or null <email> [ 0 .. 255 ] characters

Email address.

label
string [ 0 .. 255 ] characters

Contactpoint label.

location_id
string or null <uuid>

Identifier for the location of the contact point.

phone_number
string [ 0 .. 32 ] characters

Phone number.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/customers/contact-points
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Add contact point

Add a new contact point.

SecurityOAuth2 and ApiKey
Request
Request Body schema: application/json

The contact point you wish to add.

customer_id
required
string <uuid>

Identifier of the customer the contact point belongs to.

email_address
required
string or null <email> [ 0 .. 255 ] characters

Email address.

label
required
string [ 0 .. 255 ] characters

Contactpoint label.

location_id
string or null <uuid>

Identifier for the location of the contact point.

phone_number
required
string [ 0 .. 32 ] characters

Phone number.

Responses
201

Created.

Response Schema: application/json
id
string <uuid>

Contact point identifier.

customer_id
string <uuid>

Identifier of the customer the contact point belongs to.

email_address
string or null <email> [ 0 .. 255 ] characters

Email address.

label
string [ 0 .. 255 ] characters

Contactpoint label.

location_id
string or null <uuid>

Identifier for the location of the contact point.

phone_number
string [ 0 .. 32 ] characters

Phone number.

default

An error occurred - see status code and problem response for more information.

post/v2/customers/contact-points
Request samples
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "email_address": "support@jifeline.com",
  • "label": "Customer support",
  • "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
  • "phone_number": "+31611111111"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "email_address": "support@jifeline.com",
  • "label": "Customer support",
  • "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
  • "phone_number": "+31611111111"
}

Retrieve a contact point

Retrieves a contact point by its identifier.

SecurityOAuth2 and ApiKey
Request
path Parameters
contact-point-id
required
string <uuid>

The identifier of the contact point.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Contact point identifier.

customer_id
string <uuid>

Identifier of the customer the contact point belongs to.

email_address
string or null <email> [ 0 .. 255 ] characters

Email address.

label
string [ 0 .. 255 ] characters

Contactpoint label.

location_id
string or null <uuid>

Identifier for the location of the contact point.

phone_number
string [ 0 .. 32 ] characters

Phone number.

default

An error occurred - see status code and problem response for more information.

get/v2/customers/contact-points/{contact-point-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "email_address": "support@jifeline.com",
  • "label": "Customer support",
  • "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
  • "phone_number": "+31611111111"
}

Update contact point

Update a contact point by its identifier.

SecurityOAuth2 and ApiKey
Request
path Parameters
contact-point-id
required
string <uuid>

The identifier of the contact point.

Request Body schema: application/json
required

The updated contact point.

email_address
required
string or null <email> [ 0 .. 255 ] characters

Email address.

label
required
string [ 0 .. 255 ] characters

Contactpoint label.

location_id
string or null <uuid>

Identifier for the location of the contact point.

phone_number
required
string [ 0 .. 32 ] characters

Phone number.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Contact point identifier.

customer_id
string <uuid>

Identifier of the customer the contact point belongs to.

email_address
string or null <email> [ 0 .. 255 ] characters

Email address.

label
string [ 0 .. 255 ] characters

Contactpoint label.

location_id
string or null <uuid>

Identifier for the location of the contact point.

phone_number
string [ 0 .. 32 ] characters

Phone number.

default

An error occurred - see status code and problem response for more information.

put/v2/customers/contact-points/{contact-point-id}
Request samples
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "email_address": "support@jifeline.com",
  • "label": "Customer support",
  • "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
  • "phone_number": "+31611111111"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "email_address": "support@jifeline.com",
  • "label": "Customer support",
  • "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
  • "phone_number": "+31611111111"
}

Remove contact point

Remove a contact point by its identifier.

SecurityOAuth2 and ApiKey
Request
path Parameters
contact-point-id
required
string <uuid>

The identifier of the contact point.

Responses
204

Successfully removed.

default

An error occurred - see status code and problem response for more information.

delete/v2/customers/contact-points/{contact-point-id}
Response samples
application/problem+json

Returned when the request cannot be handled due to something that is perceived to be a client error.

{
  • "detail": "The request violates one or more constraints. Please resolve all of them and try again.",
  • "status": 400,
  • "title": "Bad request",
  • "type": "/problems/violations",
  • "violations": [
    ]
}
➔ Next to Custom fields