KakaoTalk Templates

The KakaoTalk template endpoint offers a way for you to manage your KakaoTalk channel-specific templates that can be used with the Conversation API.

List all templates in project GA 

Returns a paginated list of templates for the specified project. If no page token is supplied then the first `50` templates are returned in alphabetical order.
SecurityBasic or OAuth2.0
Request
path Parameters
projectId
required
string

The unique ID of the project. You can find this on the Sinch Dashboard.

plusFriendId
required
string

The unique ID of the sender.

query Parameters
filterStates
Array of strings (KakaotalkTemplateStatesEnum)

Optionally query for template by states.

Items Enum: "APPROVED" "REJECTED"
filterStatuses
Array of strings (KakaotalkTemplateStatusesEnum)

Optionally query for template by statuses.

Items Enum: "DRAFT" "IN_PROGRESS" "REJECTED"
pageSize
number [ 1 .. 1000 ]

The page size requested.

pageToken
string

The page token if retrieving the next page from a previous query.

templateName
string

Optionally query for template by name. Will return all templates with names that begin with the query string.

Responses
200

List of templates

Response Schema: application/json
totalSize
required
number

Total size of the entries matching the search query.

pageSize
required
number

Requested size of the page.

required
Array of objects (KakaotalkTemplateDto)

List of templates

previousPageToken
string

Encoded token to use in list request to fetch previous batch of entries.

nextPageToken
string

Encoded token to use in list request to fetch next batch of entries.

400

BadRequest

401

Unauthorized

404

NotFound

500

InternalServerError

get/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates
Request samples 
Response samples 
application/json
Response with templates.



{
  • "totalSize": 2,
  • "pageSize": 50,
  • "templates": [
    • {
      },
    • {}
    ]
}
Create a template in project GA 
Creates a new template with the request data.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
Request Body schema: application/json
required
Template data


required
object
Template details and information.


 
status
string
 Default:  "SUBMIT"
Create as draft or submit. Defaults to submit.


 Enum: "DRAFT" "SUBMIT"  
saveDraftOnFailure
boolean
 Default:  false
Flag to save template as draft if submission fails. Defaults to false.


 
Responses 
201
Created template


Response Schema: application/json
code
required
string
Registered delivery template code


 
id
string
The unique ID of the template.


 
state
string
The current state of the template.


 Enum: "APPROVED" "REJECTED"  
object
Any pending changes to the template.


 
object
Template details and information.


 
created
string
The UTC Date Time in ISO 8601 for when the template was created.


 
modified
string
The UTC Date Time in ISO 8601 for when the template was last modified.


 
400
BadRequest


401
Unauthorized


404
NotFound


409
Conflict


424
FailedDependency


500
InternalServerError


Callbacks 
postKakaoTalk Template received a comment
postKakaoTalk Template approved
postKakaoTalk Template rejected
post/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates
Request samples 
application/json
Minimum body to create a template.



{
  • "details": {
    • "name": "Example name",
    • "content": "Example content",
    • "language": "EN"
    }
}
Response samples 
application/json
Response when successfully creating a template.



{
  • "id": "1a76b24e-bead-4c72-b468-6c3bdfff0ee6",
  • "code": "S7yFqaKqJ8tsnBZH2CEd",
  • "changes": {},
  • "created": "2023-02-24T10:19:31.372Z",
  • "modified": "2023-02-24T10:19:31.372Z"
}
Callback payload samples 
application/json
{
  • "type": "KAKAOTALK_TEMPLATE_COMMENT_ADDED",
  • "comment": "new template comment"
}
Get template in project GA 
Returns a template for a project, with the specified name and language.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
templateCode
required
string
The unique name of the template.


 
Responses 
200
Template


Response Schema: application/json
code
required
string
Registered delivery template code


 
id
string
The unique ID of the template.


 
state
string
The current state of the template.


 Enum: "APPROVED" "REJECTED"  
object
Any pending changes to the template.


 
object
Template details and information.


 
created
string
The UTC Date Time in ISO 8601 for when the template was created.


 
modified
string
The UTC Date Time in ISO 8601 for when the template was last modified.


 
400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


get/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}
Request samples 
Response samples 
application/json
Response when successfully creating a template.



{
  • "id": "1a76b24e-bead-4c72-b468-6c3bdfff0ee6",
  • "code": "S7yFqaKqJ8tsnBZH2CEd",
  • "state": "APPROVED",
  • "details": {},
  • "created": "2023-02-24T10:19:31.372Z",
  • "modified": "2023-02-24T10:19:31.372Z"
}
Delete template for project GA 
Delete template that matches the template code.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
templateCode
required
string
The unique name of the template.


 
Responses 
204
Template deleted


400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


delete/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}
Request samples 
Response samples 
application/json
{
  • "errorCode": "project_not_initialized",
  • "message": "Project not initialized for KakaoTalk.",
  • "resolution": "Verify that the project ID is correct and that it has been onboarded for KakaoTalk."
}
Update a template in project GA 
Updates an existing template with the request data.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
templateCode
required
string
 
Request Body schema: application/json
required
Updating data


status
string
 Default:  "DRAFT"
Create as draft or submit. Defaults to draft.


 Enum: "DRAFT" "SUBMIT"  
object
Template details and information.


 
Responses 
200
Updated template


Response Schema: application/json
code
required
string
Registered delivery template code


 
id
string
The unique ID of the template.


 
state
string
The current state of the template.


 Enum: "APPROVED" "REJECTED"  
object
Any pending changes to the template.


 
object
Template details and information.


 
created
string
The UTC Date Time in ISO 8601 for when the template was created.


 
modified
string
The UTC Date Time in ISO 8601 for when the template was last modified.


 
400
BadRequest


401
Unauthorized


404
NotFound


409
Conflict


424
FailedDependency


500
InternalServerError


patch/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}
Request samples 
application/json
Minimum body to update a template.



{ }
Response samples 
application/json
Response when successfully updating a template.



{
  • "id": "1a76b24e-bead-4c72-b468-6c3bdfff0ee6",
  • "code": "S7yFqaKqJ8tsnBZH2CEd",
  • "changes": {},
  • "created": "2023-02-24T10:19:31.372Z",
  • "modified": "2023-02-24T10:19:31.372Z"
}
Lists activities on project template GA 
Paginated list of activities for a template. Ordered from the most recent one to the oldest one.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
templateCode
required
string
The unique name of the template.


 
query Parameters
pageSize
number  [ 1 .. 100 ] 
The page size requested.


 
pageToken
string
The page token if retrieving the next page from a previous query.


 
Responses 
200
Recent activities on template


Response Schema: application/json
totalSize
required
number
Total size of the entries matching the search query.


 
pageSize
required
number
Requested size of the page.


 
required
Array of objects (KakaotalkTemplateNotificationDto) 
 
previousPageToken
string
Encoded token to use in list request to fetch previous batch of entries.


 
nextPageToken
string
Encoded token to use in list request to fetch next batch of entries.


 
400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


get/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/activities
Request samples 
Response samples 
application/json
Response for all template activities.



{
  • "totalSize": 2,
  • "pageSize": 50,
  • "notifications": [
    • {
      },
    • {
      }
    ]
}
Delete template draft for project GA 
  Delete a template draft.
  
  Please note that it is only possible to delete templates that have not yet been submitted to KakaoTalk.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
templateCode
required
string
The unique name of the template.


 
Responses 
204
Template draft deleted


400
BadRequest


401
Unauthorized


404
NotFound


409
Conflict


500
InternalServerError


delete/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/changes
Request samples 
Response samples 
application/json
{
  • "errorCode": "project_not_initialized",
  • "message": "Project not initialized for KakaoTalk.",
  • "resolution": "Verify that the project ID is correct and that it has been onboarded for KakaoTalk."
}
Creates a comment for a template GA 
Creates a comment for a template.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
templateCode
required
string
The unique name of the template.


 
Request Body schema: application/json
required
Comment data


comment
required
string  [ 1 .. 65535 ] characters 
 
Responses 
201
Created comment for a template


Response Schema: application/json
type
required
string
 Value: "CREATED"  
comment
required
string
 
created
string
 
400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


post/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/comments
Request samples 
application/json
  Example body request to create a comment.
  



{
  • "comment": "Example comment."
}
Response samples 
application/json
Response when successfully creating a comment.



{
  • "type": "CREATED",
  • "comment": "Example comment",
  • "created": "2023-01-19T13:11:08.204Z"
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2025 Sinch. All rights reserved.