Hatif
    • Rate Limiting
    • Account API
      • Service Login
        POST
    • Channels API
      • Get Channels
        GET
    • Support API
      • Upload Image, Video, or PDF
        POST
      • Upload Audio File
        POST
    • Whatsapp API
      • Send Text
        POST
      • Send Template
        POST
      • Send Image
        POST
      • Send Audio
        POST
      • Send Video
        POST
      • Send File
        POST
      • Send Interactive Buttons
        POST
      • List Templates (Service Account)
        GET
    • Contact
      • Set Property Value on Contact
        PUT
      • Search Contacts
        POST
      • Delete Property Value on Contact
        DELETE
      • Create Contact
        POST
      • Update Contact
        PUT
      • Get Contacts
        GET
      • Get Contact By Id
        GET
      • Create Bulk Contacts vCards
        POST
      • Contacts History
        GET
    • Contact Properties
      • List Contact Properties
        GET
      • Contact Properties Statistics
        POST
      • Create Contact Property
        POST
      • Update Contact Property
        PUT
      • Delete Contact Property
        DELETE
    • Workspace API
      • Get Workspace Users
    • Conversations API
      • Get Conversation Timeline
      • List Conversations
      • Create Conversation
      • Assign Conversation
      • Get Conversation
      • Assign Conversation
    • Tags API
      • Tag a conversation
      • Create Tag
      • Delete Tag
      • Update Tag
      • List Tags
    • Outbound IVR
      • Create Outbound IVR
      • Get Outbound IVR Request
    • Outbound IVR Flows
      • Create Outbound IVR Flow
      • List Outbound IVR Flows
      • Get Outbound IVR Flow
      • Update Outbound IVR Flow
      • Delete Outbound IVR Flow
    • Tasks API
      • Create Task
      • List Tasks
      • Get Task
      • Update Task
      • Delete Task
      • List Task Properties
      • Create Task Property
      • List Task Projects
      • Create Task Project
      • Get Task Project
      • Rename Task Project
      • Delete Task Project
      • List Task Sections
      • Create Task Section
      • List Tasks By Conversation
      • Move Task
      • Schedule Task
      • Assign Task
      • Set Task Due Date
      • Complete Task
      • Reopen Task
      • Set Task Section
      • Move Task Project
      • Rename Task Section
      • Delete Task Section
      • Move Task Section
      • Update Task Property
      • Delete Task Property
      • Set Task Property Value
      • List Task Comments
      • Create Task Comment
      • Edit Task Comment
      • Delete Task Comment
      • Set Task Reminder
    • Teams API
      • Create Team
      • Get Team
      • Update Team
      • Delete Team
      • Add Team Members
      • Update Team Member Conversation Access
      • Remove Team Member
      • List Teams
      • List Team Member Options
      • List Team Assignment Targets
      • Assign Conversation to Team
    • Partner API
      • 2. Register customer
        • 1) Create registration
        • Update registration details
        • Resend mobile code
        • 2) Verify mobile code
        • 3) Send email code
        • 4) Verify email code
        • 5) Complete registration → workspace + workspace key
        • Issue another workspace key
      • 3. Subscribe (plan & balance)
        • Add wallet balance (top-up) → payment link
        • Plans you can sell (find the Builder plan ID)
        • Get wallet balance
        • Create quote (plan) → payment link
        • Get quote status (poll for payment)
      • 4. Phone number
        • Assign number (after payment)
        • Available numbers
        • List the workspace's channels
      • 5. Contract
        • Replaced: use Get activation link
        • Replaced: number status is on the channel
        • Get activation link
      • 6. AI agent (SIP)
        • Connect the number to your AI agent
        • Disconnect your AI agent
      • 7. Calls & events
        • Not available yet: list calls
        • Not available yet: set events webhook
    • Call Webhook
    • WhatsApp Message Webhook
    • Schemas
      • Call Webhook
      • WhatsApp Message Webhook
      • ServiceAccountTemplateDto
      • OutboundIvrOption
      • ConversationDto
      • RegistrationDetails
      • CreateTagDto
      • AbpError
      • ServiceAccountTemplateParameterDto
      • OutboundIvrQuestionStepProps
      • ChannelConversationDto
      • UpdateTagDto
      • TaskPropertyValue
      • CreateRegistration
      • ServiceAccountCreateTaskDto
      • TemplateParameterDto
      • OutboundIvrStep
      • OtpCode
      • TagDto
      • PagedResultOfTagDto
      • TaskActivityPropertySnapshot
      • ConversationTimelineDto
      • ApiCredential
      • ParameterValueDto
      • CreateOutboundIvrRequest
      • TaskActivitySnapshot
      • SaveOutboundIvrFlow
      • ChannelNotFoundError
      • OutboundIvrFlow
      • Quote
      • AiSummaryDto
      • TaskActivityDto
      • ReplyInfoDto
      • OutboundIvrAnswer
      • TaskSummaryDto
      • InternalThreadDto
      • OutboundIvrStatus
      • TaskDto
      • LocationMessageDto
      • OutboundIvrResult
      • PagedResultOfTaskDto
      • AssignationInfoDto
      • TaskPropertyDefinitionDto
      • PagedResultOfConversationDto
      • OutboundIvrAudioType
      • OutboundIvrRequest
      • PagedResultOfConversationTimelineDto
      • TaskProjectDto
      • TaskSectionDto
      • OutboundIvrWebhookPayload
      • PagedResultOfTaskProjectDto
      • PagedResultOfTaskSectionDto
      • UpdateTaskDto
      • MoveTaskDto
      • SetTaskSectionDto
      • SetTaskScheduleDto
      • AssignTaskDto
      • SetTaskDueDateDto
      • NameDto
      • MoveBeforeDto
      • TaskPropertyOptionDto
      • CreateTaskPropertyDto
      • UpdateTaskPropertyDto
      • TaskCommentDto
      • WriteTaskCommentDto
      • PagedResultOfTaskCommentDto
      • SetTaskReminderDto

    Rate Limiting

    Rate Limiting
    To keep the API fast and reliable for everyone, requests made with API credentials are rate limited per workspace.

    The limit#

    Limit120 requests per minute
    ScopeYour entire workspace with all API credentials combined
    WindowFixed 60-second window
    The limit applies to the workspace, not to each credential. Creating additional API credentials does not increase your limit.

    What happens when you exceed the limit#

    Requests over the limit receive HTTP 429 Too Many Requests:
    HTTP/1.1 429 Too Many Requests
    Retry-After: 42
    X-RateLimit-Limit: 120
    Content-Type: application/json
    
    {
     “error”: {
     “message”: “Rate limit exceeded. Retry after 42 seconds.”
     }
    }
    Retry-After — seconds until the current window resets. Wait at least this long before retrying.
    X-RateLimit-Limit — your workspace's requests-per-minute limit.
    Need a higher limit?
    If your use case genuinely needs more than 120 requests/minute, contact support.
    Modified at 2026-08-01 21:05:10
    Next
    Service Login
    Built with