Birthday subscription

POST /api/2.0/people/birthdays/reminder

Request

Subscribes to or unsubscribes from the birthday of the user with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

useridstring

User ID

onRemindboolean

Defines if the user will be notified about another user's birthday or not

Examples

POST /api/2.0/people/birthdays/reminder HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request POST \
  --url https://example.com/api/2.0/people/birthdays/reminder \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Bool value: true means that the user will get a notification

401

Unauthorized