Subscribers
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
SubscriberRequest
firstNamestringRequired
lastNamestringRequired
emailstringRequired
numbernumberRequired
groupIdsnumber[]Required
employeeNumberstringRequired
welcomeMessagestringRequired
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
429
RateLimitError
application/json
500
InternalServerError
application/json
post
/subscribersAuthorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idOrNumberOrEmailstringRequired
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
429
RateLimitError
application/json
500
InternalServerError
application/json
get
/subscribers/{idOrNumberOrEmail}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idOrNumberOrEmailstringRequired
Body
SubscriberRequest
firstNamestringRequired
lastNamestringRequired
emailstringRequired
numbernumberRequired
groupIdsnumber[]Required
employeeNumberstringRequired
welcomeMessagestringRequired
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
429
RateLimitError
application/json
500
InternalServerError
application/json
patch
/subscribers/{idOrNumberOrEmail}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idOrNumberOrEmailstringRequired
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
429
RateLimitError
application/json
500
InternalServerError
application/json
delete
/subscribers/{idOrNumberOrEmail}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pagenumberOptional
pageSizenumberOptional
sortBystringOptional
sortDirectionstring · enumOptionalPossible values:
querystringOptional
allSubscribersbooleanOptional
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
429
RateLimitError
application/json
500
InternalServerError
application/json
get
/subscribersAuthorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
querystringOptional
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
429
RateLimitError
application/json
500
InternalServerError
application/json
get
/subscribers/exportLast updated
Was this helpful?