> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jobin.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Add contact tag

> Label a contact with a tag from your workgroup.

Send a `tagId` from [List contact tags](/api-reference/contacts/list-contact-tags), or use `value` to supply the tag name.

*Rate limit: 30 requests/minute per endpoint and workgroup. [Details](/development#rate-limits).*


## OpenAPI

````yaml openapi/jobin-integration.json POST /contacts/{contactId}/tags
openapi: 3.1.0
info:
  title: Jobin Integration API
  version: 1.0.0
  description: >-
    Work with Jobin contacts and outreach sequences from your recruiting tools
    and AI assistants. See [integration
    guidelines](https://docs.jobin.cloud/development#rate-limits) for rate
    limits and retries.
servers:
  - url: https://my.jobin.cloud/api/openapi/v1
    description: Public OpenAPI base URL. Append each path below to this base URL.
security: []
paths:
  /contacts/{contactId}/tags:
    post:
      summary: Add tag to contact
      description: >-
        Creates or reuses a contact tag and applies it to one contact. This is
        intended for automation status tags such as outreach cohorts or reply
        states.
      parameters:
        - name: contactId
          in: path
          required: true
          description: Jobin contact identifier.
          schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactTagMutationRequest'
      responses:
        '201':
          description: Applied tag and contact update count.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactTagMutationResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/ApiError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ContactTagMutationRequest:
      type: object
      additionalProperties: false
      description: >-
        Tag add/remove input. Provide tagId when using an existing Jobin tag, or
        value when the automation only knows the human-readable tag label.
      properties:
        tagId:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          description: Existing Jobin tag identifier.
        value:
          type: string
          minLength: 1
          maxLength: 256
          description: >-
            Tag label to create/reuse for add operations, or remove by value for
            remove operations.
        iconName:
          type: string
          minLength: 1
          maxLength: 256
          description: Optional icon name used when creating a new tag by value.
        color:
          type: string
          minLength: 1
          maxLength: 256
          description: Optional tag color/style used when creating a new tag by value.
      anyOf:
        - required:
            - tagId
        - required:
            - value
    ContactTagMutationResponse:
      type: object
      properties:
        modifiedCount:
          type: integer
          description: Number of contact records changed by the tag update.
        tag:
          $ref: '#/components/schemas/ContactTagSummary'
        removedTagIds:
          type: array
          items:
            type: string
        removedValues:
          type: array
          items:
            type: string
    ContactTagSummary:
      type: object
      description: Minimal contact tag metadata exposed for integration filtering.
      additionalProperties: false
      required:
        - tagId
        - value
      properties:
        tagId:
          type: string
          description: Identifier to pass as tagIds when filtering contacts.
        value:
          type: string
          description: Tag label shown in Jobin.
    Error:
      type: object
      required:
        - code
        - error
      properties:
        code:
          type: string
          description: Stable error code. Input validation uses VALIDATION_ERROR.
        error:
          type: string
          description: >-
            User-facing message. Unknown failures return a generic message
            without internal details.
      example:
        code: UNHANDLED_EXCEPTION
        error: Unexpected error
    RateLimitError:
      type: object
      description: Returned when a public OpenAPI rate limit is exceeded.
      properties:
        statusCode:
          type: integer
          example: 429
        error:
          type: string
          example: Too Many Requests
        message:
          type: string
          description: Human-readable description of the limit that was exceeded.
        retryAfterSeconds:
          type: integer
          description: Seconds to wait before retrying the request.
  responses:
    BadRequest:
      description: Invalid request or expected business-rule failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: >-
        Missing or invalid authentication, or missing required authentication
        context.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found in the authenticated workgroup.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimitExceeded:
      description: >-
        Rate limit exceeded. Wait for the retry-after header before sending the
        next request.
      headers:
        retry-after:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        x-ratelimit-limit:
          description: Maximum requests allowed in the current window.
          schema:
            type: integer
        x-ratelimit-remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
        x-ratelimit-reset:
          description: Seconds until the current window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/RateLimitError'
              - $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Unexpected server failure. Internal details are masked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ApiError:
      description: Other client or server failure. Unknown errors expose a generic message.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Primary public authentication method. Create keys in Jobin.cloud under
        Workgroups > Integrations > Custom integration.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.