Spec - Tags

Table Of Contents

• Get Tags
• Add Tags
• Add Tags To Contact
• Delete Tags From Contact

Get Tags

This API retrieves the tags under the user account.

Input

• account_id (required for shared access users)
• group_id (required for shared access users)

Output

Success or failure. List of tags under the user account.

Example Request

<GetTagsRequest/>

Example Request

<GetTagsRequest account_id="12345" group_id="1"/>

Example Response

<GetTagsResponse>
    <Result>Success</Result>
    <Tags>
        <Tag>
            <TagID>182745</TagID>
            <TagName>chief executive officer</TagName>
            <Abbreviation>CEO</Abbreviation>
        </Tag>
        <Tag>
            <TagID>182746</TagID>
            <TagName>chief operating officer</TagName>
            <Abbreviation>COO</Abbreviation>
        </Tag>
        <Tag>
            <TagID>192887</TagID>
            <TagName>Facebook User</TagName>
            <Abbreviation>FB</Abbreviation>
        </Tag>
        <Tag>
            <TagID>192890</TagID>
            <TagName>Linkedin User</TagName>
            <Abbreviation>LI</Abbreviation>
        </Tag>
        <Tag>
            <TagID>192889</TagID>
            <TagName>Twitter User</TagName>
            <Abbreviation>TW</Abbreviation>
        </Tag>
    </Tags>
</GetTagsResponse>

Add Tags

This API call adds new tag(s) to the user account.

Input

• account_id (required for shared access users)
• group_id (required for shared access users)
• request_id (optional)
• TagName (required)
• Abbreviation (required)

Output

Success or failure for each tags with its new TagID.

Example Request

<AddTagsRequest>
    <Tags>
        <Tag request_id="a1b2c3">
            <TagName>Chief Executive Officer</TagName>
            <Abbreviation>CEO</Abbreviation>
        </Tag>
        <Tag request_id="d4e5f6">
            <TagName>Chief Operating Officer</TagName>
            <Abbreviation>COO</Abbreviation>
        </Tag>
    </Tags>
</AddTagsRequest>

Example Request

<AddTagsRequest account_id="12345" group_id="1">
    <Tags>
        <Tag>
            <TagName>Chief Operating Officer</TagName>
            <Abbreviation>COO</Abbreviation>
        </Tag>
    </Tags>
</AddTagsRequest>

Example Response

<AddTagsResponse>
    <Tags>
        <Tag request_id="a1b2c3">
            <Result>Success</Result>
            <TagID>194498</TagID>
        </Tag>
        <Tag request_id="d4e5f6">
            <Result>Success</Result>
            <TagID>194499</TagID>
        </Tag>
    </Tags>
</AddTagsResponse>

Add Tags To Contact

This API call assign tag(s) to a contact.

Input

• account_id (required for shared access users)
• group_id (required for shared access users)
• contact_id (required)
• request_id (optional)
• Tag with tag_id (required)

Output

Success or failure for each tags specified.

Example Request

<AddTagsToContactRequest contact_id="123">
    <Tags>
        <Tag tag_id="194498" request_id="a1b2c3"/>
        <Tag tag_id="194499" request_id="d4e5f6"/>
    </Tags>
</AddTagsToContactRequest>

Example Request

<AddTagsToContactRequest account_id="12345" group_id="1" contact_id="123">
    <Tags>
        <Tag tag_id="194498"/>
    </Tags>
</AddTagsToContactRequest>

Example Response

<AddTagsToContactResponse>
    <Tags>
        <Tag request_id="a1b2c3">
            <Result>Success</Result>
            <TagID>194498</TagID>
        </Tag>
        <Tag request_id="d4e5f6">
            <Result>Success</Result>
            <TagID>194499</TagID>
        </Tag>
    </Tags>
</AddTagsToContactResponse>

Delete Tags From Contact

This API call removes tag(s) from a contact.

Input

• account_id (required for shared access users)
• group_id (required for shared access users)
• contact_id (required)
• request_id (optional)
• Tag with tag_id (required)

Output

Success or failure for each tags specified.

Example Request

<DeleteTagsFromContactRequest contact_id="123">
    <Tags>
        <Tag tag_id="194498" request_id="a1b2c3"/>
        <Tag tag_id="194499" request_id="d4e5f6"/>
    </Tags>
</DeleteTagsFromContactRequest>

Example Request

<DeleteTagsFromContactRequest account_id="12345" group_id="1" contact_id="123">
    <Tags>
        <Tag tag_id="194498"/>
    </Tags>
</DeleteTagsFromContactRequest>

Example Response

<DeleteTagsFromContactResponse>
    <Tags>
        <Tag request_id="a1b2c3">
            <Result>Success</Result>
            <TagID>194498</TagID>
        </Tag>
        <Tag request_id="d4e5f6">
            <Result>Success</Result>
            <TagID>194499</TagID>
        </Tag>
    </Tags>
</DeleteTagsFromContactResponse>