hostinger-api-mcp 1.31.0 → 1.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +161 -2
- package/gemini-extension.json +1 -1
- package/package.json +1 -1
- package/server.json +2 -2
- package/src/core/runtime.js +1 -1
- package/src/core/runtime.ts +1 -1
- package/src/core/tools/all.js +582 -4
- package/src/core/tools/all.ts +582 -4
- package/src/core/tools/reach.js +582 -4
- package/src/core/tools/reach.ts +582 -4
- package/src/servers/agency-hosting.js +1 -1
- package/src/servers/agency-hosting.ts +1 -1
- package/src/servers/all.js +1 -1
- package/src/servers/all.ts +1 -1
- package/src/servers/billing.js +1 -1
- package/src/servers/billing.ts +1 -1
- package/src/servers/dns.js +1 -1
- package/src/servers/dns.ts +1 -1
- package/src/servers/domains.js +1 -1
- package/src/servers/domains.ts +1 -1
- package/src/servers/ecommerce.js +1 -1
- package/src/servers/ecommerce.ts +1 -1
- package/src/servers/horizons.js +1 -1
- package/src/servers/horizons.ts +1 -1
- package/src/servers/hosting.js +1 -1
- package/src/servers/hosting.ts +1 -1
- package/src/servers/mail.js +1 -1
- package/src/servers/mail.ts +1 -1
- package/src/servers/reach.js +1 -1
- package/src/servers/reach.ts +1 -1
- package/src/servers/vps.js +1 -1
- package/src/servers/vps.ts +1 -1
- package/src/servers/wordpress.js +1 -1
- package/src/servers/wordpress.ts +1 -1
- package/types.d.ts +343 -0
package/src/core/tools/reach.js
CHANGED
|
@@ -583,7 +583,7 @@ export default [
|
|
|
583
583
|
},
|
|
584
584
|
{
|
|
585
585
|
"name": "reach_listSegmentsV1",
|
|
586
|
-
"description": "Get a list of all contact segments.\n\nThis endpoint returns a list of contact segments that can be used to organize contacts.",
|
|
586
|
+
"description": "Get a list of all contact segments.\n\nThis endpoint returns a list of contact segments that can be used to organize contacts.\n\n**Deprecated.** This endpoint cannot target a profile, so it always falls back to\nthe client's default profile and cannot list the segments of any other profile. Use\n`GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead.",
|
|
587
587
|
"method": "GET",
|
|
588
588
|
"path": "/api/reach/v1/segmentation/segments",
|
|
589
589
|
"inputSchema": {
|
|
@@ -600,7 +600,7 @@ export default [
|
|
|
600
600
|
},
|
|
601
601
|
{
|
|
602
602
|
"name": "reach_createANewContactSegmentV1",
|
|
603
|
-
"description": "Create a new contact segment.\n\nThis endpoint allows creating a new contact segment that can be used to organize contacts.\nThe segment can be configured with specific criteria like email, name, subscription status, etc.",
|
|
603
|
+
"description": "Create a new contact segment.\n\nThis endpoint allows creating a new contact segment that can be used to organize contacts.\nThe segment can be configured with specific criteria like email, name, subscription status, etc.\n\n**Deprecated.** This endpoint cannot target a profile, so it always falls back to\nthe client's default profile and cannot create segments in any other profile. Use\n`POST /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead.",
|
|
604
604
|
"method": "POST",
|
|
605
605
|
"path": "/api/reach/v1/segmentation/segments",
|
|
606
606
|
"inputSchema": {
|
|
@@ -639,6 +639,8 @@ export default [
|
|
|
639
639
|
"not_dropped",
|
|
640
640
|
"bounced",
|
|
641
641
|
"not_bounced",
|
|
642
|
+
"soft_bounced",
|
|
643
|
+
"not_soft_bounced",
|
|
642
644
|
"opened",
|
|
643
645
|
"not_opened",
|
|
644
646
|
"clicked",
|
|
@@ -702,6 +704,35 @@ export default [
|
|
|
702
704
|
],
|
|
703
705
|
"group": "reach"
|
|
704
706
|
},
|
|
707
|
+
{
|
|
708
|
+
"name": "reach_countProfileSegmentContactsV1",
|
|
709
|
+
"description": "Count the contacts currently matching a segment without listing them.\n\nCheaper than paging through the segment contacts endpoint when only the size is needed.",
|
|
710
|
+
"method": "GET",
|
|
711
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/count",
|
|
712
|
+
"inputSchema": {
|
|
713
|
+
"type": "object",
|
|
714
|
+
"properties": {
|
|
715
|
+
"profileUuid": {
|
|
716
|
+
"type": "string",
|
|
717
|
+
"description": "Profile uuid parameter"
|
|
718
|
+
},
|
|
719
|
+
"segmentUuid": {
|
|
720
|
+
"type": "string",
|
|
721
|
+
"description": "Segment uuid parameter"
|
|
722
|
+
}
|
|
723
|
+
},
|
|
724
|
+
"required": [
|
|
725
|
+
"profileUuid",
|
|
726
|
+
"segmentUuid"
|
|
727
|
+
]
|
|
728
|
+
},
|
|
729
|
+
"security": [
|
|
730
|
+
{
|
|
731
|
+
"apiToken": []
|
|
732
|
+
}
|
|
733
|
+
],
|
|
734
|
+
"group": "reach"
|
|
735
|
+
},
|
|
705
736
|
{
|
|
706
737
|
"name": "reach_listProfileSegmentContactsV1",
|
|
707
738
|
"description": "Retrieve contacts associated with a specific segment for a given profile.\n\nThis endpoint allows you to fetch and filter contacts that belong to a particular segment,\nidentified by its UUID, scoped to a specific profile.",
|
|
@@ -739,9 +770,298 @@ export default [
|
|
|
739
770
|
],
|
|
740
771
|
"group": "reach"
|
|
741
772
|
},
|
|
773
|
+
{
|
|
774
|
+
"name": "reach_getProfileSegmentDetailsV1",
|
|
775
|
+
"description": "Get a single segment of a profile, including the conditions that define it.\n\nTo retrieve the contacts currently matching those conditions, use the segment contacts\nendpoint instead.",
|
|
776
|
+
"method": "GET",
|
|
777
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}",
|
|
778
|
+
"inputSchema": {
|
|
779
|
+
"type": "object",
|
|
780
|
+
"properties": {
|
|
781
|
+
"profileUuid": {
|
|
782
|
+
"type": "string",
|
|
783
|
+
"description": "Profile uuid parameter"
|
|
784
|
+
},
|
|
785
|
+
"segmentUuid": {
|
|
786
|
+
"type": "string",
|
|
787
|
+
"description": "Segment uuid parameter"
|
|
788
|
+
}
|
|
789
|
+
},
|
|
790
|
+
"required": [
|
|
791
|
+
"profileUuid",
|
|
792
|
+
"segmentUuid"
|
|
793
|
+
]
|
|
794
|
+
},
|
|
795
|
+
"security": [
|
|
796
|
+
{
|
|
797
|
+
"apiToken": []
|
|
798
|
+
}
|
|
799
|
+
],
|
|
800
|
+
"group": "reach"
|
|
801
|
+
},
|
|
802
|
+
{
|
|
803
|
+
"name": "reach_updateAProfileSegmentV1",
|
|
804
|
+
"description": "Rename a segment and/or replace the conditions that define it.\n\n`name` is always required. Omit `conditions` to rename without touching the conditions;\nsupply them and they replace the existing set entirely rather than being merged into it.\nContacts are never modified, but which of them match the segment can change immediately.",
|
|
805
|
+
"method": "PUT",
|
|
806
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}",
|
|
807
|
+
"inputSchema": {
|
|
808
|
+
"type": "object",
|
|
809
|
+
"properties": {
|
|
810
|
+
"profileUuid": {
|
|
811
|
+
"type": "string",
|
|
812
|
+
"description": "Profile uuid parameter"
|
|
813
|
+
},
|
|
814
|
+
"segmentUuid": {
|
|
815
|
+
"type": "string",
|
|
816
|
+
"description": "Segment uuid parameter"
|
|
817
|
+
},
|
|
818
|
+
"name": {
|
|
819
|
+
"type": "string",
|
|
820
|
+
"description": "name parameter"
|
|
821
|
+
},
|
|
822
|
+
"conditions": {
|
|
823
|
+
"type": "array",
|
|
824
|
+
"description": "Replaces the existing conditions entirely. Omit to keep the current ones.",
|
|
825
|
+
"items": {
|
|
826
|
+
"type": "object",
|
|
827
|
+
"description": "conditions parameter",
|
|
828
|
+
"properties": {
|
|
829
|
+
"attribute": {
|
|
830
|
+
"type": "string",
|
|
831
|
+
"description": "A built-in contact attribute, or `cf:{fieldUuid}` to target a custom\ncontact field. Custom fields are addressed by field UUID; their slug\nis not accepted.\n\nBuilt-in attributes: `email`, `note`, `domain`, `source`,\n`opt_in_method`, `subscription_status`, `subscribed_at`,\n`unsubscribed_at`, `created_at`, `tag`, `campaigns`, `processed`,\n`opened`, `clicked`, `delivered`, `bounced`, `soft_bounced`,\n`dropped`.\n\nWhich operators are accepted depends on the attribute."
|
|
832
|
+
},
|
|
833
|
+
"operator": {
|
|
834
|
+
"type": "string",
|
|
835
|
+
"description": "operator parameter",
|
|
836
|
+
"enum": [
|
|
837
|
+
"equals",
|
|
838
|
+
"not_equals",
|
|
839
|
+
"contains",
|
|
840
|
+
"not_contains",
|
|
841
|
+
"gte",
|
|
842
|
+
"lte",
|
|
843
|
+
"exists",
|
|
844
|
+
"within_last_days",
|
|
845
|
+
"not_within_last_days",
|
|
846
|
+
"older_than_days",
|
|
847
|
+
"processed",
|
|
848
|
+
"not_processed",
|
|
849
|
+
"delivered",
|
|
850
|
+
"not_delivered",
|
|
851
|
+
"dropped",
|
|
852
|
+
"not_dropped",
|
|
853
|
+
"bounced",
|
|
854
|
+
"not_bounced",
|
|
855
|
+
"soft_bounced",
|
|
856
|
+
"not_soft_bounced",
|
|
857
|
+
"opened",
|
|
858
|
+
"not_opened",
|
|
859
|
+
"clicked",
|
|
860
|
+
"not_clicked",
|
|
861
|
+
"unsubscribed",
|
|
862
|
+
"not_unsubscribed"
|
|
863
|
+
]
|
|
864
|
+
},
|
|
865
|
+
"value": {
|
|
866
|
+
"type": "string",
|
|
867
|
+
"description": "Always a string, including for numeric and date comparisons"
|
|
868
|
+
}
|
|
869
|
+
},
|
|
870
|
+
"required": [
|
|
871
|
+
"attribute",
|
|
872
|
+
"operator",
|
|
873
|
+
"value"
|
|
874
|
+
]
|
|
875
|
+
}
|
|
876
|
+
},
|
|
877
|
+
"logic": {
|
|
878
|
+
"type": "string",
|
|
879
|
+
"description": "How to combine multiple conditions. Required when conditions are given.",
|
|
880
|
+
"enum": [
|
|
881
|
+
"AND",
|
|
882
|
+
"OR"
|
|
883
|
+
]
|
|
884
|
+
}
|
|
885
|
+
},
|
|
886
|
+
"required": [
|
|
887
|
+
"profileUuid",
|
|
888
|
+
"segmentUuid",
|
|
889
|
+
"name"
|
|
890
|
+
]
|
|
891
|
+
},
|
|
892
|
+
"security": [
|
|
893
|
+
{
|
|
894
|
+
"apiToken": []
|
|
895
|
+
}
|
|
896
|
+
],
|
|
897
|
+
"group": "reach"
|
|
898
|
+
},
|
|
899
|
+
{
|
|
900
|
+
"name": "reach_deleteAProfileSegmentV1",
|
|
901
|
+
"description": "Delete a segment.\n\nOnly the segment definition is removed. The contacts that matched it are left untouched.",
|
|
902
|
+
"method": "DELETE",
|
|
903
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}",
|
|
904
|
+
"inputSchema": {
|
|
905
|
+
"type": "object",
|
|
906
|
+
"properties": {
|
|
907
|
+
"profileUuid": {
|
|
908
|
+
"type": "string",
|
|
909
|
+
"description": "Profile uuid parameter"
|
|
910
|
+
},
|
|
911
|
+
"segmentUuid": {
|
|
912
|
+
"type": "string",
|
|
913
|
+
"description": "Segment uuid parameter"
|
|
914
|
+
}
|
|
915
|
+
},
|
|
916
|
+
"required": [
|
|
917
|
+
"profileUuid",
|
|
918
|
+
"segmentUuid"
|
|
919
|
+
]
|
|
920
|
+
},
|
|
921
|
+
"security": [
|
|
922
|
+
{
|
|
923
|
+
"apiToken": []
|
|
924
|
+
}
|
|
925
|
+
],
|
|
926
|
+
"group": "reach"
|
|
927
|
+
},
|
|
928
|
+
{
|
|
929
|
+
"name": "reach_listProfileSegmentsV1",
|
|
930
|
+
"description": "Get a paginated list of the segments defined in a profile.\n\nEach entry carries the number of contacts currently matching it, which is recalculated on\nread rather than stored. Use `count_type` to count either every matching contact or only\nthe subscribed ones.",
|
|
931
|
+
"method": "GET",
|
|
932
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments",
|
|
933
|
+
"inputSchema": {
|
|
934
|
+
"type": "object",
|
|
935
|
+
"properties": {
|
|
936
|
+
"profileUuid": {
|
|
937
|
+
"type": "string",
|
|
938
|
+
"description": "Profile uuid parameter"
|
|
939
|
+
},
|
|
940
|
+
"count_type": {
|
|
941
|
+
"type": "string",
|
|
942
|
+
"description": "Which matching contacts to count for each segment",
|
|
943
|
+
"enum": [
|
|
944
|
+
"all",
|
|
945
|
+
"subscribed"
|
|
946
|
+
]
|
|
947
|
+
},
|
|
948
|
+
"page": {
|
|
949
|
+
"type": "integer",
|
|
950
|
+
"description": "Page number"
|
|
951
|
+
},
|
|
952
|
+
"per_page": {
|
|
953
|
+
"type": "integer",
|
|
954
|
+
"description": "Number of items per page"
|
|
955
|
+
}
|
|
956
|
+
},
|
|
957
|
+
"required": [
|
|
958
|
+
"profileUuid"
|
|
959
|
+
]
|
|
960
|
+
},
|
|
961
|
+
"security": [
|
|
962
|
+
{
|
|
963
|
+
"apiToken": []
|
|
964
|
+
}
|
|
965
|
+
],
|
|
966
|
+
"group": "reach"
|
|
967
|
+
},
|
|
968
|
+
{
|
|
969
|
+
"name": "reach_createAProfileSegmentV1",
|
|
970
|
+
"description": "Create a segment in a profile.\n\nA segment is a saved set of conditions rather than a fixed list, so its membership changes\nas contacts change. Creating one does not modify any contact.",
|
|
971
|
+
"method": "POST",
|
|
972
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments",
|
|
973
|
+
"inputSchema": {
|
|
974
|
+
"type": "object",
|
|
975
|
+
"properties": {
|
|
976
|
+
"profileUuid": {
|
|
977
|
+
"type": "string",
|
|
978
|
+
"description": "Profile uuid parameter"
|
|
979
|
+
},
|
|
980
|
+
"name": {
|
|
981
|
+
"type": "string",
|
|
982
|
+
"description": "name parameter"
|
|
983
|
+
},
|
|
984
|
+
"conditions": {
|
|
985
|
+
"type": "array",
|
|
986
|
+
"description": "Conditions a contact must satisfy to fall into the segment",
|
|
987
|
+
"items": {
|
|
988
|
+
"type": "object",
|
|
989
|
+
"description": "conditions parameter",
|
|
990
|
+
"properties": {
|
|
991
|
+
"attribute": {
|
|
992
|
+
"type": "string",
|
|
993
|
+
"description": "A built-in contact attribute, or `cf:{fieldUuid}` to target a custom\ncontact field. Custom fields are addressed by field UUID; their slug\nis not accepted.\n\nBuilt-in attributes: `email`, `note`, `domain`, `source`,\n`opt_in_method`, `subscription_status`, `subscribed_at`,\n`unsubscribed_at`, `created_at`, `tag`, `campaigns`, `processed`,\n`opened`, `clicked`, `delivered`, `bounced`, `soft_bounced`,\n`dropped`.\n\nWhich operators are accepted depends on the attribute."
|
|
994
|
+
},
|
|
995
|
+
"operator": {
|
|
996
|
+
"type": "string",
|
|
997
|
+
"description": "operator parameter",
|
|
998
|
+
"enum": [
|
|
999
|
+
"equals",
|
|
1000
|
+
"not_equals",
|
|
1001
|
+
"contains",
|
|
1002
|
+
"not_contains",
|
|
1003
|
+
"gte",
|
|
1004
|
+
"lte",
|
|
1005
|
+
"exists",
|
|
1006
|
+
"within_last_days",
|
|
1007
|
+
"not_within_last_days",
|
|
1008
|
+
"older_than_days",
|
|
1009
|
+
"processed",
|
|
1010
|
+
"not_processed",
|
|
1011
|
+
"delivered",
|
|
1012
|
+
"not_delivered",
|
|
1013
|
+
"dropped",
|
|
1014
|
+
"not_dropped",
|
|
1015
|
+
"bounced",
|
|
1016
|
+
"not_bounced",
|
|
1017
|
+
"soft_bounced",
|
|
1018
|
+
"not_soft_bounced",
|
|
1019
|
+
"opened",
|
|
1020
|
+
"not_opened",
|
|
1021
|
+
"clicked",
|
|
1022
|
+
"not_clicked",
|
|
1023
|
+
"unsubscribed",
|
|
1024
|
+
"not_unsubscribed"
|
|
1025
|
+
]
|
|
1026
|
+
},
|
|
1027
|
+
"value": {
|
|
1028
|
+
"type": "string",
|
|
1029
|
+
"description": "Always a string, including for numeric and date comparisons"
|
|
1030
|
+
}
|
|
1031
|
+
},
|
|
1032
|
+
"required": [
|
|
1033
|
+
"attribute",
|
|
1034
|
+
"operator",
|
|
1035
|
+
"value"
|
|
1036
|
+
]
|
|
1037
|
+
}
|
|
1038
|
+
},
|
|
1039
|
+
"logic": {
|
|
1040
|
+
"type": "string",
|
|
1041
|
+
"description": "How to combine multiple conditions",
|
|
1042
|
+
"enum": [
|
|
1043
|
+
"AND",
|
|
1044
|
+
"OR"
|
|
1045
|
+
]
|
|
1046
|
+
}
|
|
1047
|
+
},
|
|
1048
|
+
"required": [
|
|
1049
|
+
"profileUuid",
|
|
1050
|
+
"name",
|
|
1051
|
+
"conditions",
|
|
1052
|
+
"logic"
|
|
1053
|
+
]
|
|
1054
|
+
},
|
|
1055
|
+
"security": [
|
|
1056
|
+
{
|
|
1057
|
+
"apiToken": []
|
|
1058
|
+
}
|
|
1059
|
+
],
|
|
1060
|
+
"group": "reach"
|
|
1061
|
+
},
|
|
742
1062
|
{
|
|
743
1063
|
"name": "reach_listSegmentContactsV1",
|
|
744
|
-
"description": "Retrieve contacts associated with a specific segment.\n\nThis endpoint allows you to fetch and filter contacts that belong to a particular segment,\nidentified by its UUID.",
|
|
1064
|
+
"description": "Retrieve contacts associated with a specific segment.\n\nThis endpoint allows you to fetch and filter contacts that belong to a particular segment,\nidentified by its UUID.\n\n**Deprecated.** This endpoint cannot target a profile, so it always falls back to\nthe client's default profile and cannot read segments of any other profile. Use\n`GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts` instead.",
|
|
745
1065
|
"method": "GET",
|
|
746
1066
|
"path": "/api/reach/v1/segmentation/segments/{segmentUuid}/contacts",
|
|
747
1067
|
"inputSchema": {
|
|
@@ -773,7 +1093,7 @@ export default [
|
|
|
773
1093
|
},
|
|
774
1094
|
{
|
|
775
1095
|
"name": "reach_getSegmentDetailsV1",
|
|
776
|
-
"description": "Get details of a specific segment.\n\nThis endpoint retrieves information about a single segment identified by UUID.\nSegments are used to organize and group contacts based on specific criteria.",
|
|
1096
|
+
"description": "Get details of a specific segment.\n\nThis endpoint retrieves information about a single segment identified by UUID.\nSegments are used to organize and group contacts based on specific criteria.\n\n**Deprecated.** This endpoint cannot target a profile, so it always falls back to\nthe client's default profile and cannot read segments of any other profile. Use\n`GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}` instead.",
|
|
777
1097
|
"method": "GET",
|
|
778
1098
|
"path": "/api/reach/v1/segmentation/segments/{segmentUuid}",
|
|
779
1099
|
"inputSchema": {
|
|
@@ -795,6 +1115,264 @@ export default [
|
|
|
795
1115
|
],
|
|
796
1116
|
"group": "reach"
|
|
797
1117
|
},
|
|
1118
|
+
{
|
|
1119
|
+
"name": "reach_assignAContactToATagV1",
|
|
1120
|
+
"description": "Assign a tag to a single contact.\n\nUnlike the bulk endpoint this is applied immediately rather than queued. Assigning a tag\nthe contact already carries succeeds without duplicating it.",
|
|
1121
|
+
"method": "POST",
|
|
1122
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}",
|
|
1123
|
+
"inputSchema": {
|
|
1124
|
+
"type": "object",
|
|
1125
|
+
"properties": {
|
|
1126
|
+
"profileUuid": {
|
|
1127
|
+
"type": "string",
|
|
1128
|
+
"description": "Profile uuid parameter"
|
|
1129
|
+
},
|
|
1130
|
+
"tagUuid": {
|
|
1131
|
+
"type": "string",
|
|
1132
|
+
"description": "Tag uuid parameter"
|
|
1133
|
+
},
|
|
1134
|
+
"contactUuid": {
|
|
1135
|
+
"type": "string",
|
|
1136
|
+
"description": "Contact uuid parameter"
|
|
1137
|
+
}
|
|
1138
|
+
},
|
|
1139
|
+
"required": [
|
|
1140
|
+
"profileUuid",
|
|
1141
|
+
"tagUuid",
|
|
1142
|
+
"contactUuid"
|
|
1143
|
+
]
|
|
1144
|
+
},
|
|
1145
|
+
"security": [
|
|
1146
|
+
{
|
|
1147
|
+
"apiToken": []
|
|
1148
|
+
}
|
|
1149
|
+
],
|
|
1150
|
+
"group": "reach"
|
|
1151
|
+
},
|
|
1152
|
+
{
|
|
1153
|
+
"name": "reach_removeAContactFromATagV1",
|
|
1154
|
+
"description": "Remove a tag from a single contact.\n\nUnlike the bulk endpoint this is applied immediately rather than queued. Neither the tag\nnor the contact is deleted.",
|
|
1155
|
+
"method": "DELETE",
|
|
1156
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}",
|
|
1157
|
+
"inputSchema": {
|
|
1158
|
+
"type": "object",
|
|
1159
|
+
"properties": {
|
|
1160
|
+
"profileUuid": {
|
|
1161
|
+
"type": "string",
|
|
1162
|
+
"description": "Profile uuid parameter"
|
|
1163
|
+
},
|
|
1164
|
+
"tagUuid": {
|
|
1165
|
+
"type": "string",
|
|
1166
|
+
"description": "Tag uuid parameter"
|
|
1167
|
+
},
|
|
1168
|
+
"contactUuid": {
|
|
1169
|
+
"type": "string",
|
|
1170
|
+
"description": "Contact uuid parameter"
|
|
1171
|
+
}
|
|
1172
|
+
},
|
|
1173
|
+
"required": [
|
|
1174
|
+
"profileUuid",
|
|
1175
|
+
"tagUuid",
|
|
1176
|
+
"contactUuid"
|
|
1177
|
+
]
|
|
1178
|
+
},
|
|
1179
|
+
"security": [
|
|
1180
|
+
{
|
|
1181
|
+
"apiToken": []
|
|
1182
|
+
}
|
|
1183
|
+
],
|
|
1184
|
+
"group": "reach"
|
|
1185
|
+
},
|
|
1186
|
+
{
|
|
1187
|
+
"name": "reach_assignContactsToATagV1",
|
|
1188
|
+
"description": "Assign a tag to many contacts at once.\n\nPass `contact_uuids` to target specific contacts, or `all_contacts` to target every contact\nin the profile. The work is queued, so a success response means it was accepted rather than\nfinished. Contacts that already carry the tag are left alone.",
|
|
1189
|
+
"method": "POST",
|
|
1190
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts",
|
|
1191
|
+
"inputSchema": {
|
|
1192
|
+
"type": "object",
|
|
1193
|
+
"properties": {
|
|
1194
|
+
"profileUuid": {
|
|
1195
|
+
"type": "string",
|
|
1196
|
+
"description": "Profile uuid parameter"
|
|
1197
|
+
},
|
|
1198
|
+
"tagUuid": {
|
|
1199
|
+
"type": "string",
|
|
1200
|
+
"description": "Tag uuid parameter"
|
|
1201
|
+
},
|
|
1202
|
+
"contact_uuids": {
|
|
1203
|
+
"type": "array",
|
|
1204
|
+
"description": "Contacts to apply the change to. Required unless all_contacts is true.",
|
|
1205
|
+
"items": {
|
|
1206
|
+
"type": "string",
|
|
1207
|
+
"description": "contact_uuids parameter"
|
|
1208
|
+
}
|
|
1209
|
+
},
|
|
1210
|
+
"all_contacts": {
|
|
1211
|
+
"type": "boolean",
|
|
1212
|
+
"description": "Apply to every contact in the profile"
|
|
1213
|
+
}
|
|
1214
|
+
},
|
|
1215
|
+
"required": [
|
|
1216
|
+
"profileUuid",
|
|
1217
|
+
"tagUuid"
|
|
1218
|
+
]
|
|
1219
|
+
},
|
|
1220
|
+
"security": [
|
|
1221
|
+
{
|
|
1222
|
+
"apiToken": []
|
|
1223
|
+
}
|
|
1224
|
+
],
|
|
1225
|
+
"group": "reach"
|
|
1226
|
+
},
|
|
1227
|
+
{
|
|
1228
|
+
"name": "reach_removeContactsFromATagV1",
|
|
1229
|
+
"description": "Remove a tag from many contacts at once.\n\nPass `contact_uuids` to target specific contacts, or `all_contacts` to target every contact\nin the profile. The work is queued, so a success response means it was accepted rather than\nfinished. The tag itself and the contacts are not deleted.",
|
|
1230
|
+
"method": "DELETE",
|
|
1231
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts",
|
|
1232
|
+
"inputSchema": {
|
|
1233
|
+
"type": "object",
|
|
1234
|
+
"properties": {
|
|
1235
|
+
"profileUuid": {
|
|
1236
|
+
"type": "string",
|
|
1237
|
+
"description": "Profile uuid parameter"
|
|
1238
|
+
},
|
|
1239
|
+
"tagUuid": {
|
|
1240
|
+
"type": "string",
|
|
1241
|
+
"description": "Tag uuid parameter"
|
|
1242
|
+
}
|
|
1243
|
+
},
|
|
1244
|
+
"required": [
|
|
1245
|
+
"profileUuid",
|
|
1246
|
+
"tagUuid"
|
|
1247
|
+
]
|
|
1248
|
+
},
|
|
1249
|
+
"security": [
|
|
1250
|
+
{
|
|
1251
|
+
"apiToken": []
|
|
1252
|
+
}
|
|
1253
|
+
],
|
|
1254
|
+
"group": "reach"
|
|
1255
|
+
},
|
|
1256
|
+
{
|
|
1257
|
+
"name": "reach_deleteATagV1",
|
|
1258
|
+
"description": "Delete a tag and remove it from every contact carrying it.\n\nThe contacts themselves are not deleted. This is idempotent: deleting a tag that does not\nexist in the profile still succeeds.",
|
|
1259
|
+
"method": "DELETE",
|
|
1260
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}",
|
|
1261
|
+
"inputSchema": {
|
|
1262
|
+
"type": "object",
|
|
1263
|
+
"properties": {
|
|
1264
|
+
"profileUuid": {
|
|
1265
|
+
"type": "string",
|
|
1266
|
+
"description": "Profile uuid parameter"
|
|
1267
|
+
},
|
|
1268
|
+
"tagUuid": {
|
|
1269
|
+
"type": "string",
|
|
1270
|
+
"description": "Tag uuid parameter"
|
|
1271
|
+
}
|
|
1272
|
+
},
|
|
1273
|
+
"required": [
|
|
1274
|
+
"profileUuid",
|
|
1275
|
+
"tagUuid"
|
|
1276
|
+
]
|
|
1277
|
+
},
|
|
1278
|
+
"security": [
|
|
1279
|
+
{
|
|
1280
|
+
"apiToken": []
|
|
1281
|
+
}
|
|
1282
|
+
],
|
|
1283
|
+
"group": "reach"
|
|
1284
|
+
},
|
|
1285
|
+
{
|
|
1286
|
+
"name": "reach_renameATagV1",
|
|
1287
|
+
"description": "Rename a tag.\n\nThe contacts assigned to the tag are unaffected. Names are unique within a profile, so\nrenaming a tag to a name that is already taken is rejected.",
|
|
1288
|
+
"method": "PATCH",
|
|
1289
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}",
|
|
1290
|
+
"inputSchema": {
|
|
1291
|
+
"type": "object",
|
|
1292
|
+
"properties": {
|
|
1293
|
+
"profileUuid": {
|
|
1294
|
+
"type": "string",
|
|
1295
|
+
"description": "Profile uuid parameter"
|
|
1296
|
+
},
|
|
1297
|
+
"tagUuid": {
|
|
1298
|
+
"type": "string",
|
|
1299
|
+
"description": "Tag uuid parameter"
|
|
1300
|
+
},
|
|
1301
|
+
"value": {
|
|
1302
|
+
"type": "string",
|
|
1303
|
+
"description": "New tag name"
|
|
1304
|
+
}
|
|
1305
|
+
},
|
|
1306
|
+
"required": [
|
|
1307
|
+
"profileUuid",
|
|
1308
|
+
"tagUuid",
|
|
1309
|
+
"value"
|
|
1310
|
+
]
|
|
1311
|
+
},
|
|
1312
|
+
"security": [
|
|
1313
|
+
{
|
|
1314
|
+
"apiToken": []
|
|
1315
|
+
}
|
|
1316
|
+
],
|
|
1317
|
+
"group": "reach"
|
|
1318
|
+
},
|
|
1319
|
+
{
|
|
1320
|
+
"name": "reach_listProfileTagsV1",
|
|
1321
|
+
"description": "Get all tags defined in a profile.\n\nTags are the way contacts are grouped in Reach, and can be used to filter the contact\nlist or to build segments.",
|
|
1322
|
+
"method": "GET",
|
|
1323
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags",
|
|
1324
|
+
"inputSchema": {
|
|
1325
|
+
"type": "object",
|
|
1326
|
+
"properties": {
|
|
1327
|
+
"profileUuid": {
|
|
1328
|
+
"type": "string",
|
|
1329
|
+
"description": "Profile uuid parameter"
|
|
1330
|
+
}
|
|
1331
|
+
},
|
|
1332
|
+
"required": [
|
|
1333
|
+
"profileUuid"
|
|
1334
|
+
]
|
|
1335
|
+
},
|
|
1336
|
+
"security": [
|
|
1337
|
+
{
|
|
1338
|
+
"apiToken": []
|
|
1339
|
+
}
|
|
1340
|
+
],
|
|
1341
|
+
"group": "reach"
|
|
1342
|
+
},
|
|
1343
|
+
{
|
|
1344
|
+
"name": "reach_createOrFindTagsV1",
|
|
1345
|
+
"description": "Create tags in a profile.\n\nNames that already exist in the profile are not duplicated: the existing tag is returned\ninstead, so the call is safe to repeat. Every tag in the request is returned, whether it\nwas created now or already existed.",
|
|
1346
|
+
"method": "POST",
|
|
1347
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags",
|
|
1348
|
+
"inputSchema": {
|
|
1349
|
+
"type": "object",
|
|
1350
|
+
"properties": {
|
|
1351
|
+
"profileUuid": {
|
|
1352
|
+
"type": "string",
|
|
1353
|
+
"description": "Profile uuid parameter"
|
|
1354
|
+
},
|
|
1355
|
+
"names": {
|
|
1356
|
+
"type": "array",
|
|
1357
|
+
"description": "names parameter",
|
|
1358
|
+
"items": {
|
|
1359
|
+
"type": "string",
|
|
1360
|
+
"description": "names parameter"
|
|
1361
|
+
}
|
|
1362
|
+
}
|
|
1363
|
+
},
|
|
1364
|
+
"required": [
|
|
1365
|
+
"profileUuid",
|
|
1366
|
+
"names"
|
|
1367
|
+
]
|
|
1368
|
+
},
|
|
1369
|
+
"security": [
|
|
1370
|
+
{
|
|
1371
|
+
"apiToken": []
|
|
1372
|
+
}
|
|
1373
|
+
],
|
|
1374
|
+
"group": "reach"
|
|
1375
|
+
},
|
|
798
1376
|
{
|
|
799
1377
|
"name": "reach_getProfileDomainDNSStatusV1",
|
|
800
1378
|
"description": "Retrieve the DNS configuration status for a profile's domain.\n\nThis endpoint reports the state of MX, SPF, DKIM and DMARC records, including the\nactual records found and the suggested records required for correct email delivery.",
|